repo
string
commit
string
message
string
diff
string
mdsmus/musicologia-computacional
59aca58b395718b80f29e5bd76e0b153cc4c1c41
usa -simples para compilar
diff --git a/body-pt.tex b/body-pt.tex index 9b49b08..66c7e60 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,301 +1,301 @@ \section{Introdução} \label{sec:introducao} \note{introduz o assunto} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais ficaram de fora por problemas na conversão de MIDI para Lilypond (ver seção \ref{sec:metodologia}). \note{Reescrever para tirar duplicidade de Kostka e Payne} Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos musicais usuais em classes de harmonia. Neste trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o sistema \rameau{}\footnote{Está descrito em outro trabalho do autor, a citação foi removida por anonimato e será acrescentada na ocasião da publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa cada conjunto de notas a um acorde. \note{Qual trabalho? o do artigo ou o análise automática?} Para este trabalho, o \rameau{} foi extendido para realizar operações comuns de musicologia, como detecção de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, etc. Além disso \rameau{} possui vários outros algoritmos para análise harmônica, como o de \note{Reescrever para tirar duplicidade de Pardo e Birmingham} Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para o Lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos profissionais e não pela congregação \cite{bach41:371} \note{não gosto de ``escritos para serem cantados''}. Isso \note{nao começa com isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos por KP e os utilizados por Bach nos corais analizados. Bach amplia o âmbito de soprano e tenor em uma segunda maior ascendente \note{há uma forma melhor de dizer isso sem usar ascendente e descendente?}, e o do contralto em uma segunda maior descendente. A voz do baixo tem ampliação de uma terça maior em ambas direções (comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais onde as notas mais agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo estão acima da voz do contralto) (vide figura \ref{fig:035-cruzamento}), e no coral 290 existe um cruzamento simultâneo de baixo com o tenor e do contralto com o soprano (vide figura \ref{fig:290-66-74-cruzamento}). \begin{figure} \centering \subfigure[Coral 35]{ \includegraphics[scale=3]{035-cruzamento} \label{fig:035-cruzamento} } \subfigure[Coral 290]{ \includegraphics[scale=3]{290-66-74-cruzamento} \label{fig:290-66-74-cruzamento} } \subfigure[Coral 3]{ \includegraphics[scale=3]{003-38-42-cruzamento} \label{fig:003-38-42-cruzamento} } \caption{Cruzamentos entre vozes} \label{fig:coral-003} \end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar quintas e oitavas consecutivas \note{Escolher as figuras para este trecho} \note{fig} e para manter melhor condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma frase e primeiro acorde da próxima. \note{Não começar com isso} Isso ocorre nos corais 45 e 46 (quintas) e 2, 89, e 279 (oitavas) (vide figura \ref{fig:279-oitava}) \note{melhorar referência a figura}. Uma possível justificativa é a ``quebra'' de uma frase para outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no total) ocorrem no meio de frases. Todas as oitavas nessa categoria são uníssono--oitava ou oitava--uníssono (vide figura \ref{fig:oitavas-e-unissonos}). \note{``para o alívio'' é muito informal} Para o alívio dos professores de harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, 266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} \label{fig:244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} \label{fig:279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} \label{fig:329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de sexta aumentada francesa (vide figura \ref{fig:sextas-aumentadas}). \begin{figure} \centering \subfigure[Sexta alemã]{ \includegraphics[scale=3]{340-52-55-alema} } \subfigure[Sexta italiana]{ \includegraphics[scale=3]{019-4-6-italiana} } \caption{Sextas aumentadas} \label{fig:sextas-aumentadas} \end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. Verificamos o tratamento destas sétimas em \note{O termo segmento será utilizado neste artigo?} segmentos adjacentes. Em 77\% dos casos as sétimas são resolvidas descendentemente e por grau conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde de bm7 se transforma na tônica do acorde seguinte, de A. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos corais \note{não entendi a relação entre ingenuidade e erros}. Por exemplo, a cadência final do coral 362 é I$^6_4$ V$_7$ I, mas o algoritmo interpreta a antecipação para a terça do acorde final como um acorde menor do terceiro grau (iii). Além disso, como o algoritmo sempre considera que o acorde final é de tônica, ele classifica eroneamente os corais que terminam em acordes diferentes da tônica, como os que terminam em meia-cadência. \begin{figure} \centering \includegraphics[scale=3]{341-99-104-cadencia} \caption{Cadência} \label{fig:cadencia} \end{figure} \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex -%%% TeX-master: "musicologia-computacional-anppom" +%%% TeX-master: "musicologia-computacional-simples" %%% End:
mdsmus/musicologia-computacional
6d1ef5c3f9fcd725053243781b91291d866eda5f
figura soprano-agudo - retirado os tempos finais
diff --git a/figs/334-soprano-agudo.svg b/figs/334-soprano-agudo.svg index 4bf6db5..7adf33a 100644 --- a/figs/334-soprano-agudo.svg +++ b/figs/334-soprano-agudo.svg @@ -1,556 +1,556 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> <svg xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:cc="http://web.resource.org/cc/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" version="1.2" width="210" height="297" id="svg2" sodipodi:version="0.32" inkscape:version="0.45.1" sodipodi:docname="334-soprano-agudo.svg" inkscape:output_extension="org.inkscape.output.svg.inkscape" sodipodi:docbase="/home/givaldo/genos/repos/musicologia-computacional/figs"> <metadata id="metadata3600"> <rdf:RDF> <cc:Work rdf:about=""> <dc:format>image/svg+xml</dc:format> <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> </cc:Work> </rdf:RDF> </metadata> <sodipodi:namedview inkscape:window-height="725" inkscape:window-width="1024" inkscape:pageshadow="2" inkscape:pageopacity="0.0" guidetolerance="10.0" gridtolerance="10.0" objecttolerance="10.0" borderopacity="1.0" bordercolor="#666666" pagecolor="#ffffff" id="base" - inkscape:zoom="9.700454" - inkscape:cx="37.416778" - inkscape:cy="273.35381" + inkscape:zoom="13.718514" + inkscape:cx="40.217433" + inkscape:cy="277.9536" inkscape:window-x="0" inkscape:window-y="26" inkscape:current-layer="svg2" /> <defs id="defs4"> <font id="Emmentaler-20" horiz-adv-x="250"> <font-face font-family="Emmentaler" font-weight="400" font-stretch="normal" units-per-em="1000" panose-1="2 0 5 3 0 0 0 0 0 0" ascent="800" descent="-200" x-height="265" cap-height="-1e+10" bbox="-515.998 -1324.25 799.788 1249.29" underline-thickness="50" underline-position="-100" unicode-range="U+0020-U+E269" id="font-face7" /> <missing-glyph id="missing-glyph9" /> <glyph glyph-name="rests.0" unicode="" horiz-adv-x="375" d="M3 -3l3 3h182h182l2 -3l3 -2v-73v-72l-3 -3l-3 -3h-182l-182 1l-2 2l-2 2l-1 73v72z" id="glyph11" /> <glyph glyph-name="rests.1" unicode="" horiz-adv-x="375" d="M3 153l3 3h182h182l2 -3l3 -2v-73v-72l-3 -3l-3 -3h-182l-182 1l-2 2l-2 2l-1 73v72z" id="glyph13" /> <glyph glyph-name="rests.0o" unicode="" horiz-adv-x="375" d="M-139 25c5 2 649 2 654 0c6 -2 11 -6 14 -12c2 -4 3 -6 3 -12c0 -7 -1 -9 -3 -13c-3 -6 -8 -10 -14 -12c-3 -1 -17 -1 -72 -1h-68v-63v-62l-3 -3l-3 -3h-182l-182 1l-2 2l-2 2l-1 63v63h-68c-54 0 -68 0 -71 1c-6 2 -11 6 -14 12c-2 4 -2 6 -2 13c0 6 0 8 2 12 c3 6 8 10 14 12z" id="glyph15" /> <glyph glyph-name="rests.1o" unicode="" horiz-adv-x="375" d="M3 153l3 3h182h182l2 -3l3 -2v-63v-62h68c55 0 69 0 72 -1c6 -2 11 -6 14 -12c2 -4 3 -6 3 -12c0 -7 -1 -9 -3 -13c-3 -6 -8 -10 -14 -12c-5 -2 -649 -2 -654 0c-6 2 -11 6 -14 12c-2 4 -2 6 -2 13c0 6 0 8 2 12c3 6 8 10 14 12c3 1 17 1 71 1h68v62v62z" id="glyph17" /> <glyph glyph-name="rests.M3" unicode="" horiz-adv-x="450" d="M3 247l3 3h69h70l2 -3l3 -2v-245v-244l-3 -3l-3 -3h-69l-70 1l-2 2l-2 2l-1 245v244zM303 247l3 3h69h70l2 -3l3 -2v-245v-244l-3 -3l-3 -3h-69l-70 1l-2 2l-2 2l-1 245v244z" id="glyph19" /> <glyph glyph-name="rests.M2" unicode="" horiz-adv-x="150" d="M3 247l3 3h69h70l2 -3l3 -2v-245v-244l-3 -3l-3 -3h-69l-70 1l-2 2l-2 2l-1 245v244z" id="glyph21" /> <glyph glyph-name="rests.M1" unicode="" horiz-adv-x="150" d="M3 247l3 3h69h70l2 -3l3 -2v-120v-119l-3 -3l-3 -3h-69l-70 1l-2 2l-2 2l-1 120v119z" id="glyph23" /> <glyph glyph-name="rests.2" unicode="" horiz-adv-x="237" d="M63 395c4 2 9 2 13 1c3 -1 23 -25 79 -91c41 -49 76 -92 79 -95c9 -11 11 -23 7 -36c-6 -16 -21 -33 -58 -64c-12 -9 -25 -20 -28 -24c-24 -22 -37 -56 -36 -88c2 -25 10 -45 28 -66c7 -9 58 -69 75 -89c9 -11 11 -16 7 -23c-3 -7 -13 -11 -20 -8c-2 1 -6 5 -8 7 c-27 27 -91 43 -120 30c-11 -5 -17 -13 -22 -28c-12 -33 -2 -95 19 -125c6 -7 6 -10 3 -14c-3 -2 -7 -3 -10 0c-2 1 -19 23 -28 37c-22 33 -44 77 -55 110c-12 37 -14 62 -6 79c3 7 7 11 14 14c21 10 83 -1 138 -24l4 -2l-3 3c-3 3 -43 50 -99 117c-41 48 -42 49 -41 63 c0 6 0 10 2 14c6 15 22 32 57 62c12 9 25 20 28 24c35 33 46 85 26 126c-5 12 -9 18 -32 44c-10 13 -20 25 -21 26c-3 7 1 17 8 20z" id="glyph25" /> <glyph glyph-name="rests.2classical" unicode="" d="M168 204c8 1 18 1 27 -1c26 -5 46 -23 55 -48c2 -8 2 -10 2 -21c0 -15 -1 -23 -8 -35c-10 -20 -31 -36 -54 -42c-26 -7 -68 -1 -116 15l-12 4l59 -163l58 -163s-2 -1 -5 -3c-6 -4 -16 -7 -23 -7c-12 0 -27 7 -29 13c0 2 -28 97 -62 210l-60 207l2 3c5 6 15 8 21 3 c2 -2 5 -6 7 -9c9 -15 32 -42 44 -52c11 -9 17 -10 27 -6c9 5 12 10 18 37c5 20 9 31 17 39c8 9 20 16 32 19z" id="glyph27" /> <glyph glyph-name="rests.3" unicode="" d="M55 203c16 4 34 1 48 -8c15 -10 22 -22 28 -49s9 -32 18 -37c10 -4 16 -3 27 6c12 10 35 37 44 52c2 3 5 7 7 9c6 5 16 3 21 -3l2 -3l-60 -207c-34 -113 -62 -208 -62 -210c-2 -6 -17 -13 -29 -13c-7 0 -17 3 -23 7c-3 2 -5 3 -5 3l58 163l59 163l-12 -4 c-48 -16 -90 -22 -115 -15c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c9 25 29 43 55 48z" id="glyph29" /> <glyph glyph-name="rests.4" unicode="" horiz-adv-x="300" d="M110 203c16 4 34 1 48 -8c15 -10 22 -22 28 -49s9 -32 18 -37c10 -4 16 -2 27 7c8 8 22 25 32 41c12 18 12 18 16 20c7 3 15 2 19 -4l2 -3l-89 -333c-49 -183 -89 -334 -90 -335c0 -3 -8 -8 -16 -10c-8 -3 -16 -3 -24 0c-8 2 -16 8 -16 9c2 5 100 324 100 324 c0 1 -7 -1 -15 -4c-19 -6 -38 -11 -54 -14c-19 -3 -47 -3 -58 0c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c11 -5 18 -2 32 12c15 15 32 39 37 52c2 5 47 151 47 152s-6 -1 -13 -4 c-48 -16 -88 -21 -113 -14c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c9 25 29 43 55 48z" id="glyph31" /> <glyph glyph-name="rests.5" unicode="" horiz-adv-x="325" d="M140 453c16 4 34 1 48 -8c15 -10 22 -22 28 -49s9 -32 18 -37c8 -3 13 -3 19 1c9 7 25 28 39 52c7 12 10 15 17 16c6 0 11 -2 14 -6c2 -3 2 -4 -105 -460c-60 -252 -108 -459 -109 -460c-1 -5 -17 -12 -28 -12s-29 8 -28 12c1 2 85 318 86 322v3l-13 -5 c-21 -6 -40 -12 -58 -15c-13 -2 -18 -2 -34 -2c-22 0 -28 1 -44 9c-22 10 -36 27 -43 49c-2 6 -2 10 -2 21s0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c11 -4 18 -2 31 11c12 12 28 33 36 50c2 3 42 155 42 156c0 0 -7 -2 -16 -5 c-19 -6 -38 -11 -54 -14c-19 -3 -47 -3 -58 0c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c10 -4 16 -2 26 7c11 10 28 33 36 48c2 6 8 25 23 84c12 42 21 77 20 77c0 0 -7 -2 -16 -5 c-35 -11 -57 -15 -83 -15c-21 0 -28 1 -43 9c-22 10 -36 27 -43 49c-2 6 -2 10 -2 21s0 13 2 21c9 25 29 43 55 48z" id="glyph33" /> <glyph glyph-name="rests.6" unicode="" horiz-adv-x="350" d="M169 453c16 4 34 1 48 -8c15 -10 22 -22 28 -49s9 -32 18 -37c8 -3 13 -3 18 1c9 7 22 25 35 50c9 17 11 19 20 19c6 0 10 -2 13 -7c1 -2 -12 -68 -115 -582c-65 -319 -118 -582 -118 -585c-1 -5 -2 -6 -6 -8c-6 -4 -16 -7 -23 -7s-17 3 -23 7c-4 2 -5 3 -5 5 c3 10 73 324 73 325c0 0 -4 -1 -10 -3c-49 -17 -99 -24 -125 -17c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c10 -4 17 -2 27 7c12 11 30 35 38 52c5 9 6 14 21 84c9 41 17 74 17 75 c0 0 -7 -2 -14 -5c-49 -16 -92 -22 -118 -15c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c11 -4 17 -2 30 10c12 13 28 38 34 51c2 5 36 155 36 156c-1 0 -7 -2 -16 -5 c-19 -6 -38 -11 -54 -14c-19 -3 -47 -3 -58 0c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c7 -3 12 -3 18 1c11 7 27 29 38 52c5 9 6 13 22 83c9 40 16 75 17 77l1 4l-11 -4 c-17 -6 -39 -12 -55 -15c-12 -2 -18 -2 -33 -2c-22 0 -28 1 -44 9c-22 10 -36 27 -43 49c-2 6 -2 10 -2 21s0 13 2 21c9 25 29 43 55 48z" id="glyph35" /> <glyph glyph-name="rests.7" unicode="" horiz-adv-x="375" d="M199 703c16 4 34 1 48 -8c15 -10 22 -22 28 -49s9 -32 18 -37c7 -2 12 -3 17 0c7 4 19 23 31 49c8 18 10 20 18 21c6 0 11 -2 14 -6l2 -3l-118 -707c-65 -389 -118 -709 -119 -710c-1 -6 -16 -13 -28 -13c-7 0 -17 3 -23 7c-5 3 -5 3 -5 6c1 1 14 74 31 162 c16 87 29 160 30 161v3l-17 -6c-52 -17 -97 -23 -123 -16c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c10 -4 17 -2 28 8c13 11 29 33 38 51l4 10l14 74l14 75s-7 -2 -16 -5 c-50 -16 -93 -22 -119 -15c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c7 -3 12 -3 19 1c9 5 24 24 36 44c10 18 10 17 24 97c8 40 14 74 14 75c0 0 -5 -1 -13 -4 c-21 -6 -40 -12 -58 -15c-13 -2 -18 -2 -34 -2c-22 0 -28 1 -44 9c-22 10 -36 27 -43 49c-2 6 -2 10 -2 21s0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c12 -5 20 -1 35 19c8 9 15 21 21 35l5 10l14 76l15 77c-1 0 -6 -2 -14 -4 c-47 -16 -88 -22 -113 -15c-24 6 -45 22 -55 42c-7 12 -8 20 -8 35c0 11 0 13 2 21c6 15 16 29 29 38c28 18 64 15 85 -8c8 -8 12 -19 17 -39c6 -27 9 -32 18 -37c7 -3 13 -3 18 1c10 7 26 31 35 52c3 8 5 18 18 86c7 42 14 77 14 77c-1 0 -7 -2 -16 -5 c-34 -11 -56 -15 -81 -15c-22 0 -28 1 -44 9c-22 10 -36 27 -43 49c-2 6 -2 10 -2 21s0 13 2 21c9 25 29 43 55 48z" id="glyph37" /> <glyph glyph-name="accidentals.2" unicode="" horiz-adv-x="275" d="M190 373c9 5 21 0 25 -9c2 -4 2 -9 2 -75c0 -38 0 -70 1 -70l16 7c8 3 17 7 20 7c8 1 16 -4 19 -11c2 -4 2 -8 2 -39c0 -38 0 -39 -6 -45c-1 -2 -11 -7 -27 -14l-25 -10v-79c0 -44 0 -79 1 -79l16 7c8 3 17 7 20 7c8 1 16 -4 19 -11c2 -4 2 -8 2 -39c0 -38 0 -39 -6 -45 c-1 -2 -11 -7 -27 -14l-25 -10v-83c0 -79 0 -84 -2 -87c-7 -15 -27 -16 -35 -1c-1 2 -2 10 -2 78v76l-41 -17l-40 -17v-80c0 -69 0 -80 -2 -83c-6 -16 -29 -16 -35 0c-2 3 -2 13 -2 74c0 39 0 71 -1 71l-16 -7c-8 -3 -17 -7 -20 -7c-8 -1 -16 4 -19 11c-2 4 -2 8 -2 39 c0 38 0 39 6 45c1 2 11 7 27 14l25 10v79c0 44 0 79 -1 79l-16 -7c-8 -3 -17 -7 -20 -7c-8 -1 -16 4 -19 11c-2 4 -2 8 -2 39c0 38 0 39 6 45c1 2 11 7 27 14l25 10v83c0 72 0 83 2 86c6 15 27 16 35 2c1 -3 2 -11 2 -79l1 -75l40 17l40 18v78c0 69 0 80 2 83c2 5 5 8 10 10 zM178 18v79l-41 -17l-40 -17v-80c0 -77 0 -79 2 -78c1 0 19 8 40 17l39 17v79z" id="glyph39" /> <glyph glyph-name="accidentals.1" unicode="" horiz-adv-x="175" d="M80 335c9 5 21 0 25 -9c2 -4 2 -8 2 -64v-60l20 15c21 16 24 17 32 16c5 -1 12 -6 14 -11c2 -4 2 -7 2 -40c0 -34 0 -35 -2 -39s-7 -8 -34 -28l-32 -24v-76v-76l20 15c21 16 24 17 32 16c5 -1 12 -6 14 -11c2 -4 2 -7 2 -40c0 -34 0 -35 -2 -39s-7 -8 -34 -28l-32 -24 v-75c0 -70 0 -75 -2 -78c-7 -16 -28 -16 -35 0c-2 3 -2 7 -2 64v60l-20 -15c-21 -16 -24 -17 -32 -16c-5 1 -12 6 -14 11c-2 4 -2 7 -2 40c0 34 0 35 2 39s7 8 34 28l32 24v76v76l-20 -15c-21 -16 -24 -17 -32 -16c-5 1 -12 6 -14 11c-2 4 -2 7 -2 40c0 34 0 35 2 39 s7 8 34 28l32 24v74c0 65 0 75 2 78c2 5 5 8 10 10z" id="glyph41" /> <glyph glyph-name="accidentals.3" unicode="" horiz-adv-x="400" d="M306 373c9 5 21 0 25 -9c2 -4 2 -9 2 -74v-70l23 7c12 3 24 6 26 6c7 0 14 -5 17 -11c2 -4 2 -8 2 -39c0 -29 0 -36 -2 -39c-1 -4 -4 -8 -8 -9c-2 -2 -56 -17 -57 -17s-1 -36 -1 -80v-81l23 7c12 3 24 6 26 6c7 0 14 -5 17 -12c3 -6 3 -71 0 -77c-1 -4 -4 -8 -8 -9 c-2 -2 -56 -17 -57 -17s-1 -35 -1 -79c0 -74 0 -79 -2 -82c-7 -15 -27 -16 -35 -1c-1 2 -2 10 -2 77v74l-37 -11l-36 -10l-1 -78c0 -70 -1 -78 -2 -80c-8 -15 -28 -14 -35 1c-2 3 -2 8 -2 75s0 71 -2 71c-1 -1 -17 -5 -37 -11l-35 -9v-76c0 -65 0 -76 -2 -79 c-6 -16 -29 -16 -35 0c-2 3 -2 13 -2 74v70l-23 -7c-12 -3 -24 -6 -26 -6c-7 0 -14 5 -17 12c-2 3 -2 7 -2 38c0 29 0 36 2 39c1 4 4 8 8 9c2 2 56 17 57 17s1 36 1 80v81l-23 -7c-12 -3 -24 -6 -26 -6c-7 0 -14 5 -17 12c-2 3 -2 7 -2 38c0 29 0 36 2 39c1 4 4 8 8 9 c2 2 56 17 57 17s1 35 1 78c0 68 0 79 2 82c6 15 27 16 35 2c1 -3 2 -11 2 -77l1 -74l36 11l37 10v78c0 70 1 78 2 81c8 14 28 13 35 -1c2 -4 2 -9 2 -76s0 -71 2 -71c1 1 17 5 37 11l35 9v75c0 66 0 76 2 79c2 5 5 8 10 10zM294 27v80s-17 -5 -37 -10l-36 -11l-1 -80 c0 -76 0 -80 2 -80c1 1 17 5 37 11l35 9v81zM181 -5c0 64 0 80 -1 80s-18 -5 -37 -10l-36 -10v-81v-80l7 2c3 1 20 6 37 10l30 9v80z" id="glyph43" /> <glyph glyph-name="accidentals.0" unicode="" horiz-adv-x="167" d="M6 381c10 2 22 1 32 -3l5 -2v-26c0 -15 0 -56 -1 -92s-1 -65 -1 -66c1 0 25 4 54 10c37 7 55 10 57 10c6 -1 10 -5 13 -10l2 -4l3 -266c2 -147 4 -276 4 -287v-21l-5 -2c-6 -2 -14 -4 -20 -4s-14 2 -20 4l-5 2v26c0 15 0 56 1 92s1 65 1 66c-1 0 -25 -4 -54 -10 c-37 -7 -55 -10 -57 -10c-6 1 -10 5 -13 10l-2 5l-3 265c-2 147 -4 276 -4 287v21l4 1c2 1 6 3 9 4zM130 110c0 1 0 2 -1 2c-2 0 -88 -17 -89 -17c0 -1 -3 -206 -3 -207c1 0 89 17 90 17c0 1 3 161 3 205z" id="glyph45" /> <glyph glyph-name="accidentals.M2" unicode="" horiz-adv-x="200" d="M-12 463c11 2 26 1 35 -4c3 -1 5 -2 5 -2c0 -1 -6 -284 -7 -321v-24l5 4c21 17 50 28 79 30c26 1 46 -7 64 -25c9 -9 15 -17 20 -28c14 -31 14 -65 1 -93c-7 -14 -16 -26 -30 -40s-27 -25 -59 -48c-45 -33 -50 -38 -62 -53c-5 -6 -10 -13 -12 -14c-5 -5 -13 -8 -18 -8 c-6 0 -14 4 -18 9c-6 7 -6 -12 -11 288c-3 151 -6 285 -7 299v24l5 2c3 1 7 3 10 4zM96 100c-5 3 -8 3 -14 4c-9 0 -13 -1 -21 -5c-16 -8 -28 -26 -31 -48c0 -4 -1 -27 -2 -53c0 -44 0 -69 3 -92l1 -7l13 11c16 14 38 36 47 48c13 17 24 37 28 55c2 7 2 11 2 25 c0 15 0 18 -2 26c-5 19 -13 30 -24 36z" id="glyph47" /> <glyph glyph-name="accidentals.M1" unicode="" horiz-adv-x="200" d="M157 462c11 3 26 2 35 -3c3 -1 5 -2 5 -2c0 -1 -3 -135 -6 -299c-5 -251 -6 -299 -7 -303c-5 -15 -20 -22 -32 -16c-8 4 -11 7 -21 20c-12 15 -17 20 -61 53c-33 23 -46 34 -60 48s-23 26 -30 40c-13 28 -13 62 1 93c5 11 11 19 20 28c18 18 38 26 64 25 c29 -2 58 -13 79 -30l5 -4v24c-1 37 -7 320 -7 321c2 1 10 4 15 5zM107 100c-6 3 -8 3 -15 4c-21 1 -34 -13 -42 -40c-2 -8 -2 -11 -2 -26c0 -14 0 -18 2 -25c4 -18 15 -38 28 -55c9 -12 31 -34 48 -48l13 -11v7c3 23 3 48 3 92c-1 26 -2 49 -2 53c-2 16 -11 32 -21 41 c-2 2 -8 6 -12 8z" id="glyph49" /> <glyph glyph-name="accidentals.M4" unicode="" horiz-adv-x="362" d="M-12 463c11 2 26 1 35 -4c3 -1 5 -2 5 -2c0 -1 -6 -283 -7 -321v-24l8 8c18 18 41 27 66 26c15 -1 28 -6 41 -15c3 -3 6 -5 6 -5s-2 73 -4 161c-1 88 -3 162 -3 165v5l6 2c11 5 22 6 34 3c5 -1 13 -4 15 -5c0 -1 -6 -284 -7 -321v-24l5 4c16 15 43 26 67 29 c22 3 38 0 56 -9c35 -18 57 -65 49 -108c-4 -25 -15 -45 -38 -68c-14 -15 -28 -26 -61 -50c-25 -18 -42 -31 -48 -36c-2 -2 -7 -9 -12 -15s-10 -13 -12 -14c-5 -5 -13 -8 -18 -8c-6 0 -14 4 -18 9c-6 7 -6 8 -7 67c-1 29 -1 54 -1 54c-1 0 -3 -3 -6 -7 c-9 -10 -25 -25 -54 -51c-37 -32 -40 -36 -49 -49c-4 -6 -8 -13 -10 -15c-4 -4 -12 -8 -17 -8c-6 0 -14 4 -18 9c-6 7 -6 -12 -11 288c-3 151 -6 285 -7 299v24l5 2c3 1 7 3 10 4zM72 101c-9 5 -23 3 -32 -4s-17 -24 -19 -42c-2 -14 -2 -119 0 -139c1 -9 2 -17 2 -18 s4 2 11 11c30 33 47 64 55 99c2 9 2 14 2 32c0 12 0 23 -1 27c-3 17 -9 29 -18 34zM254 101c-11 5 -27 3 -38 -4c-10 -7 -18 -20 -22 -35c-2 -7 -2 -11 -3 -55c-1 -46 -1 -73 2 -101v-7l7 6c24 21 44 42 55 59c11 16 17 29 22 47c2 9 2 11 2 28c0 16 0 18 -2 28 c-5 18 -12 29 -23 34z" id="glyph51" /> <glyph glyph-name="accidentals.M3" unicode="" horiz-adv-x="362" d="M-12 463c11 2 23 1 34 -4l6 -2v-23c-2 -51 -4 -183 -4 -184c1 0 112 63 114 64c0 1 -1 31 -2 68c0 37 -1 69 -1 71c0 4 0 4 6 6c14 7 29 7 43 0l6 -2v-22c-1 -12 -1 -37 -2 -57v-35l39 22l38 23h8c6 0 8 -1 12 -3c9 -5 14 -15 13 -25c-1 -5 -3 -9 -7 -14 c-1 -2 -21 -14 -53 -32c-39 -23 -51 -30 -51 -31c-1 -2 -1 -32 -2 -67c-1 -36 -1 -74 -2 -85v-19l5 4c16 15 43 26 67 29c22 3 38 0 56 -9c35 -18 57 -65 49 -108c-4 -25 -15 -45 -38 -68c-14 -15 -28 -26 -61 -50c-25 -18 -42 -31 -48 -36c-2 -2 -7 -9 -12 -15 s-10 -13 -12 -14c-5 -5 -13 -8 -18 -8c-6 0 -14 4 -18 9c-6 7 -6 8 -7 67c-1 29 -1 54 -1 54c-1 0 -3 -3 -6 -7c-9 -10 -25 -25 -54 -51c-37 -32 -40 -36 -49 -49c-4 -6 -8 -13 -10 -15c-4 -4 -12 -8 -17 -8c-6 0 -14 4 -18 9c-6 7 -6 -1 -9 163c-2 82 -3 151 -3 153v4 l-45 -26c-33 -19 -46 -26 -50 -27c-10 -1 -20 3 -25 12c-3 5 -3 6 -3 13c0 6 0 8 2 12c2 2 4 5 5 7c1 1 27 16 58 33c31 18 56 32 56 33c0 0 0 51 -2 113c-1 61 -2 114 -2 116c0 5 0 5 5 7c3 1 7 3 10 4zM139 252c0 3 0 5 -1 5l-57 -33l-57 -33l-1 -5c0 -2 -1 -20 -1 -39 l-1 -35l8 8c18 18 41 27 66 26c15 -1 28 -6 41 -15c3 -3 6 -5 6 -5s-1 28 -2 61c0 33 -1 62 -1 65zM72 101c-9 5 -23 3 -32 -4s-17 -24 -19 -42c-2 -14 -2 -119 0 -139c1 -9 2 -17 2 -18s4 2 11 11c30 33 47 64 55 99c2 9 2 14 2 32c0 12 0 23 -1 27c-3 17 -9 29 -18 34z M254 101c-11 5 -27 3 -38 -4c-10 -7 -18 -20 -22 -35c-2 -7 -2 -11 -3 -55c-1 -46 -1 -73 2 -101v-7l7 6c24 21 44 42 55 59c11 16 17 29 22 47c2 9 2 11 2 28c0 16 0 18 -2 28c-5 18 -12 29 -23 34z" id="glyph53" /> <glyph glyph-name="accidentals.4" unicode="" d="M-6 133c1 1 3 2 4 2s22 -2 46 -5c30 -3 46 -5 48 -6c5 -2 6 -6 6 -23c1 -30 9 -54 23 -69l4 -4l4 4c14 15 22 39 23 69c0 17 1 21 6 23c4 3 93 12 97 10c1 0 3 -2 4 -3c1 -3 1 -5 -4 -49c-2 -26 -5 -47 -5 -49c-2 -4 -5 -5 -17 -6c-33 -1 -53 -7 -70 -18 c-3 -2 -7 -5 -8 -6l-2 -3l2 -3c1 -1 5 -4 8 -6c16 -11 34 -16 64 -18c18 -1 21 -2 23 -6c0 -2 3 -23 5 -49c5 -44 5 -46 4 -49c-1 -1 -3 -3 -4 -3c-4 -2 -93 7 -97 10c-5 2 -6 6 -6 23c-1 30 -9 54 -23 69l-4 5l-4 -5c-14 -15 -22 -39 -23 -69c0 -17 -1 -21 -6 -23 c-4 -3 -93 -12 -97 -10c-1 0 -3 2 -4 3c-1 3 -1 5 4 49c2 26 5 47 5 49c2 4 5 5 23 6c30 2 48 7 64 18c3 2 7 5 8 6l2 3l-2 3c-1 1 -5 4 -8 6c-17 11 -37 17 -69 18c-13 1 -16 2 -18 6c-1 4 -10 94 -10 96c1 1 2 3 4 4z" id="glyph55" /> <glyph glyph-name="accidentals.rightparen" unicode="" horiz-adv-x="150" d="M43 261c2 1 5 2 7 2c5 0 9 -3 19 -20c44 -67 70 -132 79 -201c2 -20 2 -64 0 -83c-9 -70 -35 -135 -79 -202c-10 -17 -14 -20 -19 -20c-7 0 -13 6 -13 13c0 2 2 5 5 10c33 51 50 106 56 184c2 21 2 91 0 113c-6 77 -23 132 -56 183c-3 4 -5 8 -5 10c0 4 3 9 6 11z" id="glyph57" /> <glyph glyph-name="accidentals.leftparen" unicode="" horiz-adv-x="0" d="M-56 261c6 4 13 2 17 -4c3 -5 3 -9 -3 -17c-33 -51 -50 -106 -56 -183c-2 -22 -2 -92 0 -113c6 -78 23 -133 56 -184c3 -5 5 -8 5 -10c0 -7 -6 -13 -13 -13c-5 0 -9 3 -19 20c-44 67 -70 132 -79 202c-2 19 -2 63 0 83c9 69 35 134 79 201c6 10 11 17 13 18z" id="glyph59" /> <glyph glyph-name="arrowheads.open.01" unicode="" horiz-adv-x="20" d="M-238 123c2 1 5 2 8 2c7 0 11 -2 21 -13c52 -56 122 -89 199 -92c19 -1 21 -1 26 -9c3 -4 4 -5 4 -11s-1 -7 -4 -11c-5 -8 -7 -8 -26 -9c-77 -3 -147 -36 -199 -92c-10 -11 -14 -13 -21 -13c-11 0 -20 9 -20 20c0 7 3 12 15 24c31 33 74 62 114 78c4 1 7 3 7 3s-3 2 -7 3 c-21 9 -50 25 -70 39c-22 16 -52 45 -57 54c-5 10 -1 22 10 27z" id="glyph61" /> <glyph glyph-name="arrowheads.open.0M1" unicode="" d="M222 123c7 3 16 2 22 -3c6 -6 8 -16 4 -24c-5 -9 -35 -38 -57 -54c-20 -14 -49 -30 -70 -39c-4 -1 -7 -3 -7 -3s3 -2 7 -3c40 -16 83 -45 114 -78c12 -12 15 -17 15 -24c0 -11 -9 -20 -20 -20c-7 0 -11 2 -21 13c-52 56 -122 89 -199 92c-19 1 -21 1 -26 9 c-3 4 -3 5 -3 11s0 7 3 11c5 8 7 8 26 9c77 3 148 36 199 92c5 5 10 10 13 11z" id="glyph63" /> <glyph glyph-name="arrowheads.open.11" unicode="" horiz-adv-x="125" d="M-7 19c5 2 13 1 18 -3c8 -5 8 -7 9 -26c3 -77 36 -147 92 -199c11 -10 13 -14 13 -21c0 -11 -9 -20 -20 -20c-7 0 -12 3 -24 15c-33 31 -62 74 -78 114c-1 4 -3 7 -3 7s-2 -3 -3 -7c-16 -40 -45 -83 -78 -114c-12 -12 -17 -15 -24 -15c-11 0 -20 9 -20 20c0 7 2 11 13 21 c56 51 89 123 92 197c0 10 1 17 2 20c1 4 5 8 11 11z" id="glyph65" /> <glyph glyph-name="arrowheads.open.1M1" unicode="" horiz-adv-x="125" d="M-113 248c5 3 11 2 17 0c9 -5 38 -35 54 -57c14 -20 30 -49 39 -70c1 -4 3 -7 3 -7s2 3 3 7c16 40 45 83 78 114c12 12 17 15 24 15c11 0 20 -9 20 -20c0 -7 -2 -11 -13 -21c-56 -52 -89 -122 -92 -199c-1 -19 -1 -21 -9 -26c-4 -3 -5 -3 -11 -3s-7 0 -11 3 c-8 5 -8 7 -9 26c-3 77 -36 147 -92 199c-11 10 -13 14 -13 21c0 8 4 15 12 18z" id="glyph67" /> <glyph glyph-name="arrowheads.close.01" unicode="" horiz-adv-x="0" d="M-245 124c1 0 4 1 6 1c3 -1 6 -3 15 -12c21 -21 53 -42 98 -64c48 -23 98 -39 125 -39c4 0 6 -1 8 -2c2 -2 3 -4 3 -8s-1 -6 -3 -8c-2 -1 -4 -2 -8 -2c-27 0 -77 -16 -125 -39c-45 -22 -77 -43 -98 -64c-11 -11 -12 -11 -16 -11c-5 0 -9 2 -9 6c-1 2 0 9 1 16 c7 36 10 64 10 102s-2 64 -10 103c-2 12 -2 14 -1 17z" id="glyph69" /> <glyph glyph-name="arrowheads.close.0M1" unicode="" d="M236 124c2 1 9 0 11 -2c3 -2 3 -6 1 -20c-7 -35 -10 -66 -10 -102s3 -67 10 -102c1 -7 2 -14 1 -16c0 -4 -4 -6 -9 -6c-4 0 -5 0 -15 11c-22 21 -54 42 -99 64c-48 23 -98 39 -125 39c-4 0 -6 1 -8 2c-2 2 -2 4 -2 8s0 6 2 8c2 1 4 2 8 2c27 0 77 16 125 39 c45 22 77 43 98 64c6 6 11 11 12 11z" id="glyph71" /> <glyph glyph-name="arrowheads.close.11" unicode="" horiz-adv-x="125" d="M-5 9c2 1 4 1 6 1c6 -1 9 -5 9 -11c0 -27 16 -77 39 -125c22 -45 43 -77 64 -98c11 -11 12 -12 12 -16c0 -5 -3 -9 -7 -9c-2 -1 -9 0 -16 1c-35 7 -66 10 -102 10s-67 -3 -102 -10c-7 -1 -14 -2 -16 -1c-4 0 -6 4 -6 9c0 4 0 5 11 16c15 15 30 36 47 65 c31 55 56 125 56 158c0 5 2 9 5 10z" id="glyph73" /> <glyph glyph-name="arrowheads.close.1M1" unicode="" horiz-adv-x="125" d="M-120 249c3 1 4 1 15 -1c34 -7 68 -10 105 -10c38 0 66 3 102 10c7 1 14 2 16 1c4 0 7 -4 7 -9c0 -4 -1 -5 -12 -15c-21 -22 -42 -54 -64 -99c-23 -48 -39 -98 -39 -125c0 -4 -1 -6 -2 -8c-4 -4 -12 -4 -16 0c-1 2 -2 4 -2 8c0 27 -16 77 -39 125c-22 45 -43 77 -64 98 c-9 9 -11 12 -12 15c0 4 2 8 5 10z" id="glyph75" /> <glyph glyph-name="dots.dot" unicode="" horiz-adv-x="112" d="M46 56c7 2 22 0 29 -2c18 -7 28 -17 35 -35c2 -6 2 -8 2 -18c0 -11 0 -13 -2 -19c-7 -18 -18 -29 -36 -35c-9 -3 -26 -3 -35 0c-18 6 -29 17 -36 35c-2 5 -2 8 -2 18s0 13 2 18c2 8 8 17 12 22c7 7 20 14 31 16z" id="glyph77" /> <glyph glyph-name="noteheads.uM2" unicode="" horiz-adv-x="495" d="M502 887c2 1 6 1 10 1c11 -1 19 -7 23 -17c2 -5 2 -987 0 -992c-8 -20 -36 -23 -47 -4l-2 5l-1 39v40l-6 -8c-23 -36 -78 -66 -142 -80c-57 -12 -122 -12 -179 0c-64 14 -119 44 -142 80l-5 8l-1 -40v-39l-3 -5c-4 -6 -10 -11 -15 -12c-10 -3 -22 1 -27 8 c-6 8 -6 1 -6 142c0 106 0 131 1 134c8 21 37 23 47 4l3 -5v-53l1 -52l5 8c23 36 78 66 142 80c57 12 122 12 179 0c64 -14 119 -44 142 -80l6 -8v415l1 415l2 4c3 6 8 10 14 12zM239 109c-10 2 -30 3 -38 2c-17 -3 -33 -14 -42 -29c-13 -23 -17 -61 -8 -96 c12 -48 52 -84 107 -96c12 -2 33 -2 42 0c19 6 34 21 42 41c8 23 9 54 2 83c-12 47 -51 83 -105 95z" id="glyph79" /> <glyph glyph-name="noteheads.dM2" unicode="" horiz-adv-x="495" d="M-24 137c2 0 6 1 9 1c9 0 17 -5 22 -13l3 -4v-40l1 -40l5 8c23 36 78 66 142 80c57 12 122 12 179 0c64 -14 119 -44 142 -80l6 -8v40l1 40l2 4c6 9 15 14 25 13s18 -8 22 -17c2 -5 2 -237 0 -242c-8 -20 -36 -23 -47 -4l-2 5l-1 39v40l-6 -8c-23 -36 -78 -66 -142 -80 c-57 -12 -122 -12 -179 0c-64 14 -119 44 -142 80l-5 8l-1 -415v-414l-3 -5c-6 -9 -15 -14 -25 -13s-19 9 -22 18c-1 2 -1 170 -1 497l1 494l2 4c3 6 8 10 14 12zM239 109c-10 2 -30 3 -38 2c-17 -3 -33 -14 -42 -29c-13 -23 -17 -61 -8 -96c12 -48 52 -84 107 -96 c12 -2 33 -2 42 0c19 6 34 21 42 41c8 23 9 54 2 83c-12 47 -51 83 -105 95z" id="glyph81" /> <glyph glyph-name="noteheads.sM1" unicode="" horiz-adv-x="495" d="M-24 137c2 0 6 1 9 1c9 0 17 -5 22 -13l3 -4v-40l1 -40l5 8c23 36 78 66 142 80c57 12 122 12 179 0c64 -14 119 -44 142 -80l6 -8v40l1 40l2 4c6 9 15 14 25 13s18 -8 22 -17c2 -5 2 -237 0 -242c-8 -20 -36 -23 -47 -4l-2 5l-1 39v40l-6 -8c-23 -36 -78 -66 -142 -80 c-57 -12 -122 -12 -179 0c-64 14 -119 44 -142 80l-5 8l-1 -40v-39l-3 -5c-6 -9 -15 -14 -25 -13s-19 9 -22 18c-1 3 -1 45 -1 122l1 119l2 4c3 6 8 10 14 12zM239 109c-10 2 -30 3 -38 2c-17 -3 -33 -14 -42 -29c-13 -23 -17 -61 -8 -96c12 -48 52 -84 107 -96 c12 -2 33 -2 42 0c19 6 34 21 42 41c8 23 9 54 2 83c-12 47 -51 83 -105 95z" id="glyph83" /> <glyph glyph-name="noteheads.s0" unicode="" horiz-adv-x="495" d="M214 137c41 3 86 0 123 -8c64 -14 118 -44 143 -81c11 -16 14 -29 14 -48s-3 -32 -14 -48c-25 -37 -79 -67 -143 -81c-57 -12 -122 -12 -179 0c-64 14 -118 44 -143 81c-11 16 -14 29 -14 48s3 32 14 48c32 48 110 83 199 89zM239 109c-10 2 -30 3 -38 2 c-17 -3 -33 -14 -42 -29c-13 -23 -17 -61 -8 -96c12 -48 52 -84 107 -96c12 -2 33 -2 42 0c19 6 34 21 42 41c8 23 9 54 2 83c-12 47 -51 83 -105 95z" id="glyph85" /> <glyph glyph-name="noteheads.s1" unicode="" horiz-adv-x="347" d="M232 136c9 0 23 1 35 1c16 -1 20 -1 29 -3c14 -4 23 -9 31 -17s13 -17 17 -28c3 -12 3 -35 0 -51c-10 -46 -28 -84 -52 -109c-32 -32 -91 -55 -156 -62c-66 -8 -96 -3 -116 16c-8 8 -13 17 -17 28c-3 12 -3 35 0 51c10 46 28 84 52 108c13 13 25 22 48 33 c36 18 75 28 129 33zM284 105c-14 3 -27 0 -57 -15c-21 -11 -54 -31 -105 -65c-53 -34 -77 -55 -85 -70c-6 -13 -7 -26 -1 -39c10 -19 32 -27 56 -19c24 9 63 31 133 78c53 34 77 55 85 70c6 13 7 26 1 39c-6 11 -14 17 -27 21z" id="glyph87" /> <glyph glyph-name="noteheads.s2" unicode="" horiz-adv-x="329" d="M199 137c12 1 40 0 51 -2c40 -9 67 -31 76 -64c3 -11 3 -34 1 -47c-9 -41 -37 -81 -77 -111c-34 -25 -73 -42 -111 -49c-15 -2 -45 -2 -57 0c-42 9 -70 31 -79 66c-3 10 -3 33 -1 46c9 41 37 81 78 111c36 28 78 45 119 50z" id="glyph89" /> <glyph glyph-name="noteheads.s0diamond" unicode="" horiz-adv-x="495" d="M234 137c7 1 26 0 34 -2s22 -9 32 -15c5 -3 16 -12 26 -20c46 -36 50 -38 102 -49c41 -8 55 -15 63 -32c3 -7 4 -8 4 -19s-1 -12 -4 -19c-8 -17 -22 -24 -63 -32c-52 -11 -56 -13 -102 -49c-20 -17 -30 -23 -43 -29c-14 -7 -20 -8 -35 -8c-16 0 -22 1 -36 8 c-13 6 -23 12 -43 29c-46 36 -50 38 -102 49c-41 8 -55 15 -63 32c-3 7 -3 8 -3 19s0 12 3 19c8 17 22 24 63 32c52 11 56 13 102 49c30 24 47 34 65 37zM230 72c-11 3 -23 4 -28 2c-11 -4 -15 -15 -17 -46c-3 -39 0 -58 10 -70c8 -8 23 -16 49 -24c54 -17 63 -12 66 38 c3 39 0 58 -10 70c-10 10 -34 21 -70 30z" id="glyph91" /> <glyph glyph-name="noteheads.s1diamond" unicode="" horiz-adv-x="364" d="M309 137c9 2 22 1 29 -2c13 -5 25 -21 26 -35c1 -13 -4 -24 -21 -50c-6 -9 -12 -19 -14 -23c-8 -14 -11 -28 -13 -57c-2 -27 -4 -38 -9 -49c-7 -14 -22 -24 -41 -29c-13 -3 -39 -3 -65 0c-24 3 -44 4 -55 2c-12 -1 -26 -6 -53 -17c-30 -12 -37 -14 -50 -14 c-15 0 -21 2 -29 10c-13 12 -17 26 -12 41c3 10 7 17 19 36c6 9 12 19 14 23c8 14 11 28 13 58c2 26 4 37 9 48c7 14 22 24 42 29c12 3 38 3 64 0c24 -3 44 -4 55 -2c12 1 27 6 52 16c21 9 29 12 39 15zM278 77c-7 4 -18 5 -26 2c-18 -5 -46 -20 -101 -57 c-58 -37 -77 -56 -79 -74c-1 -15 10 -27 26 -29c18 -1 45 12 115 59c45 29 69 49 75 62c8 16 3 31 -10 37z" id="glyph93" /> <glyph glyph-name="noteheads.s2diamond" unicode="" horiz-adv-x="369" d="M318 137c4 0 10 1 15 1c15 -1 24 -7 32 -23c3 -7 4 -8 4 -15s-1 -9 -4 -15c-6 -13 -11 -19 -40 -44c-38 -33 -42 -39 -65 -92c-16 -38 -24 -52 -38 -67c-14 -13 -23 -18 -37 -19c-9 0 -19 1 -41 6c-34 8 -40 8 -73 -1c-19 -5 -23 -5 -32 -5c-11 0 -12 0 -17 2 c-7 4 -13 10 -18 20c-3 7 -3 8 -3 16c0 6 0 8 3 14c6 13 11 19 40 44c38 33 42 39 65 93c16 37 24 51 38 66c14 13 23 18 37 19c9 0 19 -1 41 -6c33 -8 41 -8 69 0c9 2 20 5 24 6z" id="glyph95" /> <glyph glyph-name="noteheads.s0triangle" unicode="" horiz-adv-x="579" d="M27 182c16 3 15 4 50 -13c85 -42 165 -69 256 -87c64 -13 117 -19 189 -21c30 -1 33 -1 38 -3c16 -6 22 -18 17 -30c-4 -8 -11 -12 -36 -19c-61 -16 -106 -32 -156 -56c-81 -39 -149 -88 -215 -152c-22 -22 -23 -22 -37 -21c-23 2 -39 10 -41 22c0 2 1 7 2 12s3 15 4 23 c13 93 -7 186 -58 265c-10 15 -23 32 -31 41c-11 11 -13 17 -9 25c3 7 12 12 27 14zM209 57l-50 16l-26 9l7 -14c25 -52 37 -105 37 -161v-15l12 10c57 46 124 85 192 112l12 4l-9 2c-55 7 -119 21 -175 37z" id="glyph97" /> <glyph glyph-name="noteheads.d1triangle" unicode="" horiz-adv-x="418" d="M19 164c5 2 8 2 14 2l8 -1l17 -11c59 -37 117 -62 183 -78c44 -11 83 -16 133 -18c21 -1 25 -1 29 -3c13 -6 19 -18 14 -30c-4 -10 -11 -14 -32 -21c-106 -36 -191 -96 -262 -188c-8 -10 -13 -13 -23 -14c-12 -1 -26 5 -31 14c-4 6 -4 10 -2 27c4 21 5 31 6 54 c2 78 -20 156 -64 223c-4 6 -8 12 -9 15c-4 12 4 23 19 29zM133 56c-9 3 -20 8 -24 10c-4 1 -7 3 -7 2c0 0 1 -3 3 -7c15 -39 24 -82 27 -128l2 -19l10 9c35 33 83 67 124 88c5 2 8 4 8 5c-1 0 -9 1 -17 3c-44 8 -85 21 -126 37z" id="glyph99" /> <glyph glyph-name="noteheads.u1triangle" unicode="" horiz-adv-x="418" d="M19 164c5 2 8 2 14 2l8 -1l17 -11c59 -37 117 -62 183 -78c44 -11 83 -16 133 -18c21 -1 25 -1 29 -3c13 -6 19 -18 14 -30c-4 -10 -11 -14 -32 -21c-106 -36 -191 -96 -262 -188c-8 -10 -13 -13 -23 -14c-12 -1 -26 5 -31 14c-4 6 -4 10 -2 27c4 21 5 31 6 54 c2 78 -20 156 -64 223c-4 6 -8 12 -9 15c-4 12 4 23 19 29zM133 56c-9 3 -20 8 -24 10c-4 1 -7 3 -7 2c0 0 1 -3 3 -7c15 -39 24 -82 27 -128l2 -19l10 9c35 33 83 67 124 88c5 2 8 4 8 5c-1 0 -9 1 -17 3c-44 8 -85 21 -126 37z" id="glyph101" /> <glyph glyph-name="noteheads.u2triangle" unicode="" horiz-adv-x="348" d="M17 164c10 4 17 2 34 -11c50 -39 105 -66 165 -82c33 -8 74 -14 103 -14c7 0 10 -1 14 -2c17 -6 21 -28 8 -41c-4 -4 -7 -6 -20 -11c-89 -37 -162 -97 -213 -179c-12 -18 -18 -23 -31 -22c-10 1 -20 11 -22 20c0 3 1 12 2 22c11 89 -2 174 -38 253c-3 7 -8 17 -11 23 c-4 6 -7 12 -7 15c-3 12 4 25 16 29z" id="glyph103" /> <glyph glyph-name="noteheads.d2triangle" unicode="" horiz-adv-x="348" d="M17 164c10 4 17 2 34 -11c50 -39 105 -66 165 -82c33 -8 74 -14 103 -14c7 0 10 -1 14 -2c17 -6 21 -28 8 -41c-4 -4 -7 -6 -20 -11c-89 -37 -162 -97 -213 -179c-12 -18 -18 -23 -31 -22c-10 1 -20 11 -22 20c0 3 1 12 2 22c11 89 -2 174 -38 253c-3 7 -8 17 -11 23 c-4 6 -7 12 -7 15c-3 12 4 25 16 29z" id="glyph105" /> <glyph glyph-name="noteheads.s0slash" unicode="" horiz-adv-x="754" d="M315 262c2 1 91 1 218 1c210 0 216 -1 218 -2c2 -3 4 -8 2 -12s-310 -508 -312 -509c-2 -2 -3 -2 -219 -2c-211 0 -217 0 -219 1c-2 3 -4 8 -2 12c1 2 300 491 309 505c2 3 4 5 5 6zM631 183l6 10h-142h-142l-1 -2c-2 -2 -215 -351 -230 -375l-5 -9h142l142 1l112 183z " id="glyph107" /> <glyph glyph-name="noteheads.s1slash" unicode="" horiz-adv-x="586" d="M315 262c2 1 57 1 134 1c128 0 132 -1 134 -2c2 -3 4 -8 2 -12s-310 -508 -312 -509c-2 -2 -3 -2 -135 -2c-129 0 -133 0 -135 1c-2 3 -4 8 -2 12c1 2 300 491 309 505c2 3 4 5 5 6zM463 183l6 10h-58h-58l-1 -2c-2 -2 -215 -351 -230 -375l-5 -9h58l58 1l112 183z" id="glyph109" /> <glyph glyph-name="noteheads.s2slash" unicode="" horiz-adv-x="429" d="M315 262c2 1 25 1 56 1c50 0 53 -1 55 -2c2 -3 4 -8 2 -12s-310 -508 -312 -509c-2 -2 -3 -2 -56 -2c-52 0 -55 0 -57 1c-2 3 -4 8 -2 12c1 2 300 491 309 505c2 3 4 5 5 6z" id="glyph111" /> <glyph glyph-name="noteheads.s0cross" unicode="" horiz-adv-x="429" d="M94 149c4 1 9 1 12 -1c2 0 27 -17 56 -37l53 -36l53 36c29 20 54 37 56 38c7 3 8 3 57 -30c24 -16 45 -31 46 -32c3 -4 3 -14 0 -18c-1 -1 -24 -17 -51 -35l-48 -34l48 -34c27 -18 50 -34 51 -35c3 -4 3 -14 0 -18c-1 -1 -22 -16 -46 -32c-49 -33 -50 -33 -57 -30 c-2 1 -27 18 -56 38l-53 36l-53 -36c-29 -20 -54 -37 -56 -38c-7 -3 -8 -3 -57 30c-24 16 -45 31 -46 32c-3 4 -3 14 0 18c1 1 24 17 51 35l49 34l-49 34c-27 18 -50 34 -51 35c-3 4 -3 13 -1 17c2 3 87 61 92 63zM157 77c-29 20 -53 36 -55 37c-2 2 -3 2 -29 -17 c-15 -10 -27 -19 -27 -19c0 -1 21 -16 47 -34c27 -18 49 -34 50 -35c3 -4 3 -14 0 -18c-1 -1 -23 -17 -50 -35c-26 -18 -48 -33 -48 -34s54 -38 55 -37l55 37l55 37h5h6l54 -37l55 -37c1 -1 55 36 55 37s-22 16 -48 34c-27 18 -49 34 -50 35c-3 4 -3 14 0 18 c1 1 23 17 50 35c26 18 48 33 48 34s-54 38 -55 37l-55 -37l-54 -36h-6h-5z" id="glyph113" /> <glyph glyph-name="noteheads.s1cross" unicode="" horiz-adv-x="379" d="M73 143c3 1 8 1 11 0c2 0 26 -18 54 -39l52 -39l52 39c31 23 53 39 55 39c2 1 5 1 7 1c4 -1 71 -50 74 -54c2 -3 2 -13 0 -16c-1 -2 -24 -19 -50 -38l-48 -36l48 -36c26 -19 49 -36 50 -38c2 -3 2 -13 0 -16c-3 -4 -70 -53 -74 -54c-2 0 -5 0 -7 1c-2 0 -24 16 -55 39 l-52 39l-52 -39c-31 -23 -53 -39 -55 -39c-2 -1 -5 -1 -7 -1c-4 1 -71 50 -74 54c-2 3 -2 13 0 16c1 2 24 19 50 38l48 36l-48 36c-26 19 -49 36 -50 38c-2 3 -2 13 0 16s65 50 71 53zM132 70l-53 39c-1 0 -35 -26 -36 -27c0 0 21 -17 48 -36c26 -19 48 -36 49 -38 c2 -3 2 -13 0 -16c-1 -2 -23 -19 -49 -38c-27 -19 -48 -35 -48 -36c0 0 8 -7 18 -14l18 -13l6 4l53 39c30 22 47 34 49 35h6c2 -1 19 -13 50 -35l52 -39l6 -4l18 13c10 7 18 14 18 14c0 1 -21 17 -48 36c-26 19 -48 36 -49 38c-1 1 -1 4 -1 8s0 7 1 8c1 2 23 19 49 38 c27 19 48 35 48 36c0 0 -8 7 -18 14l-18 13l-6 -4l-52 -39c-31 -22 -48 -34 -50 -35h-6c-2 1 -21 14 -55 39z" id="glyph115" /> <glyph glyph-name="noteheads.s2cross" unicode="" horiz-adv-x="329" d="M30 137c4 2 9 1 13 -1c2 -1 30 -24 63 -51l59 -49l59 49c33 27 61 50 63 51c4 2 8 3 12 1c2 -1 9 -6 16 -11c13 -11 15 -14 15 -20c0 -7 -1 -8 -61 -57l-59 -49l59 -49c60 -49 61 -50 61 -57c0 -6 -2 -9 -15 -20c-7 -5 -14 -10 -16 -11c-4 -2 -8 -1 -12 1 c-2 1 -30 24 -63 51l-59 49l-59 -49c-33 -27 -61 -50 -63 -51c-4 -2 -8 -3 -12 -1c-2 1 -9 6 -16 11c-13 11 -15 14 -15 20c0 7 1 8 61 57l59 49l-59 49c-60 49 -61 50 -61 57c0 6 2 9 15 20c7 5 14 10 15 11z" id="glyph117" /> <glyph glyph-name="noteheads.s2xcircle" unicode="" horiz-adv-x="391" d="M179 172c6 1 40 0 50 -1c23 -4 50 -13 71 -25c22 -12 46 -33 60 -53c14 -19 25 -45 29 -66c2 -13 2 -41 0 -54c-4 -21 -15 -47 -29 -66c-14 -20 -38 -41 -60 -53c-21 -12 -51 -22 -75 -25c-12 -2 -47 -2 -59 0c-24 3 -54 13 -75 25c-22 12 -46 33 -60 53 c-14 19 -25 45 -29 66c-2 13 -2 41 0 54c4 21 15 47 29 66c14 20 38 41 60 53s53 22 75 25c5 1 11 1 13 1zM215 135c-27 3 -57 -1 -81 -10c-9 -3 -28 -12 -32 -15c-2 -1 2 -5 45 -43c26 -23 48 -41 49 -41l48 41c43 38 47 42 45 43c-4 3 -23 12 -32 15c-11 4 -29 8 -42 10z M119 42l-48 42c-1 0 -15 -19 -20 -27c-5 -11 -8 -19 -11 -31c-3 -14 -3 -38 0 -52c3 -12 6 -20 11 -30c5 -9 19 -28 20 -28c1 1 96 83 96 84zM328 74c-4 6 -7 10 -8 10s-96 -83 -96 -84s95 -83 96 -84c1 0 15 19 20 28c5 10 8 18 11 30c2 8 2 12 2 26s0 18 -2 26 c-5 19 -11 33 -23 48zM244 -67c-25 22 -47 41 -48 41c0 1 -17 -13 -49 -41c-43 -38 -47 -42 -45 -43c1 0 6 -3 12 -6c51 -27 112 -27 163 0c6 3 11 6 12 6c2 1 -2 5 -45 43z" id="glyph119" /> <glyph glyph-name="noteheads.s0do" unicode="" horiz-adv-x="495" d="M239 110c2 1 6 2 9 2c2 0 6 -1 9 -2c2 -2 56 -44 119 -94c108 -86 114 -91 116 -96c4 -6 4 -12 1 -18s-6 -9 -11 -12l-5 -2h-229c-229 0 -230 0 -234 2c-6 3 -9 6 -12 12s-3 11 1 18c2 5 8 10 117 96c62 50 116 92 119 94zM330 -4c-43 34 -79 62 -80 63 c-3 2 -4 1 -83 -62l-80 -63l81 -1h160l80 1z" id="glyph121" /> <glyph glyph-name="noteheads.d1do" unicode="" horiz-adv-x="347" d="M164 110c3 1 7 2 10 2c2 0 6 -1 9 -2c4 -3 11 -10 82 -94c46 -55 78 -94 80 -97c3 -6 3 -11 0 -17s-6 -9 -11 -12l-5 -2h-155h-155l-5 2c-6 3 -9 6 -12 12s-3 11 0 17c2 3 34 42 80 97c71 84 78 91 82 94zM227 -9c-26 32 -49 59 -51 61l-2 3l-52 -61l-51 -60l51 -1h102 l52 1z" id="glyph123" /> <glyph glyph-name="noteheads.u1do" unicode="" horiz-adv-x="347" d="M164 110c3 1 7 2 10 2c2 0 6 -1 9 -2c4 -3 11 -10 82 -94c46 -55 78 -94 80 -97c3 -6 3 -11 0 -17s-6 -9 -11 -12l-5 -2h-155h-155l-5 2c-6 3 -9 6 -12 12s-3 11 0 17c2 3 34 42 80 97c71 84 78 91 82 94zM227 -9c-26 32 -49 59 -51 61l-2 3l-52 -61l-51 -60l51 -1h102 l52 1z" id="glyph125" /> <glyph glyph-name="noteheads.d2do" unicode="" horiz-adv-x="329" d="M155 109c3 2 7 3 10 3c2 0 6 -1 9 -3c5 -2 9 -7 78 -93c40 -51 73 -94 75 -96c3 -7 3 -12 0 -18s-6 -9 -11 -12l-5 -2h-146h-146l-5 2c-6 3 -9 6 -12 12s-3 11 0 18c2 2 35 45 75 96c69 86 73 91 78 93z" id="glyph127" /> <glyph glyph-name="noteheads.u2do" unicode="" horiz-adv-x="329" d="M155 109c3 2 7 3 10 3c2 0 6 -1 9 -3c5 -2 9 -7 78 -93c40 -51 73 -94 75 -96c3 -7 3 -12 0 -18s-6 -9 -11 -12l-5 -2h-146h-146l-5 2c-6 3 -9 6 -12 12s-3 11 0 18c2 2 35 45 75 96c69 86 73 91 78 93z" id="glyph129" /> <glyph glyph-name="noteheads.s0re" unicode="" horiz-adv-x="495" d="M14 110l5 2h229h229l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -38c0 -35 -1 -43 -5 -57c-10 -35 -35 -62 -78 -83c-32 -15 -68 -24 -115 -30c-22 -2 -77 -2 -99 0c-47 6 -83 15 -115 30c-43 21 -68 48 -78 83c-4 14 -5 22 -5 57c0 32 0 34 2 38c3 6 6 9 12 12zM450 47v20h-202 h-203v-20c0 -15 0 -21 2 -29c9 -42 51 -69 124 -80c26 -4 39 -4 77 -4c37 0 50 0 77 4c72 11 114 38 123 80c2 8 2 14 2 29z" id="glyph131" /> <glyph glyph-name="noteheads.u1re" unicode="" horiz-adv-x="347" d="M14 110l5 2h155h155l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -38c0 -38 -1 -48 -7 -65c-11 -37 -38 -67 -77 -86c-57 -28 -122 -28 -178 0c-40 19 -67 49 -78 86c-6 17 -7 27 -7 65c0 32 0 34 2 38c3 6 6 9 12 12zM302 48v19h-128h-129v-19c0 -27 2 -37 10 -52 c14 -30 47 -52 88 -60c16 -3 45 -3 61 0c41 8 74 30 88 60c8 15 10 25 10 52z" id="glyph133" /> <glyph glyph-name="noteheads.d1re" unicode="" horiz-adv-x="347" d="M14 110l5 2h155h155l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -38c0 -38 -1 -48 -7 -65c-11 -37 -38 -67 -77 -86c-57 -28 -122 -28 -178 0c-40 19 -67 49 -78 86c-6 17 -7 27 -7 65c0 32 0 34 2 38c3 6 6 9 12 12zM302 48v19h-128h-129v-19c0 -27 2 -37 10 -52 c14 -30 47 -52 88 -60c16 -3 45 -3 61 0c41 8 74 30 88 60c8 15 10 25 10 52z" id="glyph135" /> <glyph glyph-name="noteheads.u2re" unicode="" horiz-adv-x="329" d="M13 110l6 2h146h146l5 -2c5 -3 9 -7 11 -13c2 -4 2 -9 2 -43c-1 -40 -1 -42 -7 -60c-6 -20 -21 -44 -36 -59c-25 -23 -55 -38 -92 -45c-13 -2 -46 -2 -59 0c-37 7 -67 22 -92 45c-15 15 -30 39 -36 59c-6 18 -6 20 -7 60c0 34 0 39 2 43c2 6 6 10 11 13z" id="glyph137" /> <glyph glyph-name="noteheads.d2re" unicode="" horiz-adv-x="329" d="M13 110l6 2h146h146l5 -2c5 -3 9 -7 11 -13c2 -4 2 -9 2 -43c-1 -40 -1 -42 -7 -60c-6 -20 -21 -44 -36 -59c-25 -23 -55 -38 -92 -45c-13 -2 -46 -2 -59 0c-37 7 -67 22 -92 45c-15 15 -30 39 -36 59c-6 18 -6 20 -7 60c0 34 0 39 2 43c2 6 6 10 11 13z" id="glyph139" /> <glyph glyph-name="noteheads.s0mi" unicode="" horiz-adv-x="495" d="M242 111c5 3 12 0 126 -45c65 -26 117 -47 119 -49c4 -3 8 -11 8 -17s-4 -14 -8 -17c-2 -2 -54 -23 -119 -49c-106 -42 -115 -45 -120 -45c-6 0 -15 3 -120 45c-63 25 -116 46 -117 47c-6 3 -11 11 -11 19c0 6 4 14 8 17c2 2 54 23 118 48c63 25 115 46 116 46zM315 27 c-44 17 -81 32 -82 32c-2 0 -134 -52 -134 -53c0 0 160 -64 163 -65c1 0 134 52 134 53z" id="glyph141" /> <glyph glyph-name="noteheads.s1mi" unicode="" horiz-adv-x="329" d="M156 110c6 3 11 3 18 0c5 -3 141 -88 147 -93c4 -3 8 -11 8 -17s-4 -14 -8 -17c-6 -5 -142 -90 -147 -93c-7 -2 -12 -3 -18 0c-5 2 -145 90 -149 93c-3 4 -7 12 -7 17c0 6 4 14 8 17c6 5 142 90 148 93zM204 25l-50 31c-1 0 -79 -49 -79 -50l50 -31c31 -19 50 -31 51 -30 c2 0 78 48 78 49z" id="glyph143" /> <glyph glyph-name="noteheads.s2mi" unicode="" horiz-adv-x="329" d="M156 110c6 3 11 3 18 0c5 -3 141 -88 147 -93c4 -3 8 -11 8 -17s-4 -14 -8 -17c-6 -5 -142 -90 -147 -93c-7 -2 -12 -3 -18 0c-5 2 -145 90 -149 93c-3 4 -7 12 -7 17c0 6 4 14 8 17c6 5 142 90 148 93z" id="glyph145" /> <glyph glyph-name="noteheads.u0fa" unicode="" horiz-adv-x="495" d="M14 110l5 2h229h229l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -98v-93l-2 -6c-4 -8 -14 -14 -22 -13c-3 1 -274 108 -446 177c-8 3 -16 6 -17 8c-4 3 -8 11 -8 17c0 4 3 11 6 15c2 1 5 3 8 5zM450 6v61h-155h-154c1 -1 308 -123 308 -123c1 0 1 28 1 62z" id="glyph147" /> <glyph glyph-name="noteheads.d0fa" unicode="" horiz-adv-x="495" d="M14 110c3 2 6 2 10 2c3 -1 61 -23 218 -86c117 -47 220 -87 228 -91c8 -3 16 -6 17 -8c4 -3 8 -11 8 -16s-3 -12 -6 -16c-2 -1 -5 -3 -7 -5l-5 -2h-229h-229l-5 2c-6 3 -9 6 -12 12c-2 4 -2 6 -2 98s0 94 2 98c3 6 6 9 12 12zM200 -5l-154 61c-1 0 -1 -28 -1 -61v-62h155 h154c0 1 -70 28 -154 62z" id="glyph149" /> <glyph glyph-name="noteheads.u1fa" unicode="" horiz-adv-x="347" d="M14 110l5 2h155h155l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -98s0 -94 -2 -98c-3 -6 -6 -9 -11 -12c-7 -2 -12 -3 -18 0s-306 181 -309 183c-3 3 -7 12 -7 17c0 4 3 11 6 15c2 1 5 3 8 5zM302 8v59h-99h-98c0 -1 43 -26 96 -57c52 -31 96 -57 98 -58l3 -2v58z" id="glyph151" /> <glyph glyph-name="noteheads.d1fa" unicode="" horiz-adv-x="347" d="M14 110c6 2 11 3 17 0s306 -181 309 -183c3 -3 7 -12 7 -16c0 -5 -3 -12 -6 -16c-2 -1 -5 -3 -7 -5l-5 -2h-155h-155l-5 2c-6 3 -9 6 -12 12c-2 4 -2 6 -2 98s0 94 2 98c3 6 6 9 12 12zM147 -10c-53 31 -97 57 -99 58l-3 2v-58v-59h99h98c0 1 -43 26 -95 57z" id="glyph153" /> <glyph glyph-name="noteheads.u2fa" unicode="" horiz-adv-x="329" d="M14 110l5 2h146h146l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -98s0 -94 -2 -98c-3 -6 -6 -9 -11 -12c-7 -2 -12 -3 -18 0c-5 2 -287 180 -291 183c-3 3 -7 12 -7 17c0 4 3 11 6 15c2 1 5 3 8 5z" id="glyph155" /> <glyph glyph-name="noteheads.d2fa" unicode="" horiz-adv-x="329" d="M14 110c6 2 11 3 17 0c5 -2 287 -180 291 -183c3 -3 7 -12 7 -16c0 -5 -3 -12 -6 -16c-2 -1 -5 -3 -7 -5l-5 -2h-146h-146l-5 2c-6 3 -9 6 -12 12c-2 4 -2 6 -2 98s0 94 2 98c3 6 6 9 12 12z" id="glyph157" /> <glyph glyph-name="noteheads.s0la" unicode="" horiz-adv-x="495" d="M14 110l5 2h229h229l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -98s0 -94 -2 -98c-3 -6 -6 -9 -11 -12l-5 -2h-229h-229l-5 2c-6 3 -9 6 -12 12c-2 4 -2 6 -2 98s0 94 2 98c3 6 6 9 12 12zM450 0v67h-202h-203v-67v-67h203h202v67z" id="glyph159" /> <glyph glyph-name="noteheads.s1la" unicode="" horiz-adv-x="347" d="M14 110l5 2h155h155l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -98s0 -94 -2 -98c-3 -6 -6 -9 -11 -12l-5 -2h-155h-155l-5 2c-6 3 -9 6 -12 12c-2 4 -2 6 -2 98s0 94 2 98c3 6 6 9 12 12zM302 0v67h-128h-129v-67v-67h129h128v67z" id="glyph161" /> <glyph glyph-name="noteheads.s2la" unicode="" horiz-adv-x="329" d="M14 110l5 2h146h146l5 -2c5 -3 8 -6 11 -12c2 -4 2 -6 2 -98s0 -94 -2 -98c-3 -6 -6 -9 -11 -12l-5 -2h-146h-146l-5 2c-6 3 -9 6 -12 12c-2 4 -2 6 -2 98s0 94 2 98c3 6 6 9 12 12z" id="glyph163" /> <glyph glyph-name="noteheads.s0ti" unicode="" horiz-adv-x="495" d="M216 111c78 6 159 -11 230 -46c21 -10 38 -21 42 -25c9 -9 9 -22 1 -30c-3 -3 -27 -16 -116 -61l-117 -59c-6 -2 -11 -2 -17 0l-117 59c-89 45 -113 58 -116 61c-8 8 -8 21 1 30c4 4 21 15 42 25c52 26 109 42 167 46zM293 64c-14 2 -60 3 -70 2c-41 -3 -71 -9 -102 -20 c-18 -5 -50 -19 -50 -20s175 -90 177 -90c1 0 176 89 176 90s-16 8 -29 13c-31 12 -68 21 -102 25z" id="glyph165" /> <glyph glyph-name="noteheads.u1ti" unicode="" horiz-adv-x="347" d="M151 111c20 2 44 1 67 -4c35 -6 72 -24 100 -46c26 -22 33 -33 27 -46c-2 -4 -11 -11 -80 -63c-43 -33 -80 -60 -82 -62c-7 -3 -12 -3 -18 0c-3 2 -40 29 -83 62c-69 52 -78 59 -80 63c-6 13 1 24 27 46c33 27 78 45 122 50zM193 66c-33 4 -69 -3 -100 -17 c-12 -6 -35 -20 -35 -22c0 -1 115 -88 116 -88c0 0 115 87 115 88s-13 10 -21 14c-21 13 -49 22 -75 25z" id="glyph167" /> <glyph glyph-name="noteheads.d1ti" unicode="" horiz-adv-x="347" d="M151 111c20 2 44 1 67 -4c35 -6 72 -24 100 -46c26 -22 33 -33 27 -46c-2 -4 -11 -11 -80 -63c-43 -33 -80 -60 -82 -62c-7 -3 -12 -3 -18 0c-3 2 -40 29 -83 62c-69 52 -78 59 -80 63c-6 13 1 24 27 46c33 27 78 45 122 50zM193 66c-33 4 -69 -3 -100 -17 c-12 -6 -35 -20 -35 -22c0 -1 115 -88 116 -88c0 0 115 87 115 88s-13 10 -21 14c-21 13 -49 22 -75 25z" id="glyph169" /> <glyph glyph-name="noteheads.u2ti" unicode="" horiz-adv-x="329" d="M148 111c1 1 11 1 21 0c19 0 31 -1 47 -6c38 -9 74 -30 100 -58c9 -9 12 -15 13 -22c1 -11 3 -8 -77 -73c-41 -33 -75 -60 -77 -61c-5 -3 -16 -3 -21 0c-2 1 -36 28 -76 61c-81 65 -79 62 -78 73c1 7 4 13 13 22c31 33 78 57 123 63c4 1 10 1 12 1z" id="glyph171" /> <glyph glyph-name="noteheads.d2ti" unicode="" horiz-adv-x="329" d="M148 111c1 1 11 1 21 0c19 0 31 -1 47 -6c38 -9 74 -30 100 -58c9 -9 12 -15 13 -22c1 -11 3 -8 -77 -73c-41 -33 -75 -60 -77 -61c-5 -3 -16 -3 -21 0c-2 1 -36 28 -76 61c-81 65 -79 62 -78 73c1 7 4 13 13 22c31 33 78 57 123 63c4 1 10 1 12 1z" id="glyph173" /> @@ -1876,1276 +1876,1102 @@ unicode="" horiz-adv-x="150" d="M18 470c1 1 3 2 3 2c1 0 1 -93 1 -206v-206l37 18l37 19l6 -3c27 -13 45 -41 45 -71c0 -27 -12 -51 -40 -80c-22 -21 -39 -33 -58 -38l-7 -2l-31 19l-32 19v245v246l4 5c7 10 26 29 35 33zM61 50c-3 2 -5 3 -6 3c0 0 -8 -4 -17 -8l-16 -8v-27v-26l30 -18 c33 -20 33 -20 41 -17c5 2 5 3 7 8c12 37 -4 76 -39 93z" id="glyph621" /> <glyph glyph-name="flags.mensuralu03" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l38 -44c45 -53 44 -52 49 -62c13 -27 11 -61 -3 -105c-5 -15 -121 -309 -124 -315c-6 -12 -17 -21 -25 -21c-3 0 -4 0 -6 3c-1 2 -1 5 -1 8c1 2 27 70 59 151c65 167 63 162 67 179c3 11 3 14 3 28c1 18 -1 25 -8 36c-2 3 -21 26 -41 50l-38 45h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8z" id="glyph623" /> <glyph glyph-name="flags.mensuralu13" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l10 -11c6 -6 13 -14 16 -17c29 -36 44 -84 42 -131c-3 -50 -18 -97 -48 -142c-8 -11 -45 -59 -64 -82c-8 -10 -15 -14 -21 -14c-3 0 -4 0 -6 3c-1 2 -1 5 -1 8c2 9 7 17 36 53c15 19 30 39 34 45c41 61 43 144 5 202c-8 11 -15 20 -26 31l-7 8h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8z" id="glyph625" /> <glyph glyph-name="flags.mensuralu23" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l25 -28c35 -39 42 -50 49 -76c5 -21 6 -38 4 -61c-4 -30 -12 -59 -26 -91c-6 -14 -89 -191 -92 -196c-7 -12 -17 -20 -25 -20c-4 0 -4 0 -6 4c-1 3 -1 4 0 8c0 3 19 45 45 98c24 51 46 99 49 106c24 60 24 112 0 148c-4 5 -17 21 -30 35l-23 26h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8z" id="glyph627" /> <glyph glyph-name="flags.mensurald03" unicode="" horiz-adv-x="0" d="M3 520c3 2 6 3 9 3s4 0 6 -3c1 -2 1 -5 1 -8c-1 -2 -27 -70 -59 -151c-65 -167 -63 -162 -67 -179c-3 -11 -3 -14 -3 -28c-1 -18 1 -25 8 -36c2 -3 21 -26 42 -50l38 -45h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-38 44 c-45 53 -44 52 -49 63c-13 26 -11 60 3 104c5 15 121 309 124 315c3 7 11 15 16 18z" id="glyph629" /> <glyph glyph-name="flags.mensurald13" unicode="" horiz-adv-x="0" d="M2 370c4 2 6 3 10 3c3 0 4 0 6 -3c1 -2 1 -5 1 -8c-2 -9 -7 -17 -36 -53c-15 -19 -30 -39 -34 -45c-41 -61 -43 -144 -5 -202c8 -11 15 -20 26 -31l7 -8h19c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-10 11c-6 6 -13 14 -16 18 c-29 35 -44 83 -42 130c2 33 10 66 23 97c13 28 25 46 58 89c34 42 37 45 42 49z" id="glyph631" /> <glyph glyph-name="flags.mensurald23" unicode="" horiz-adv-x="0" d="M3 445c3 2 6 3 9 3c4 0 4 0 6 -4c1 -3 1 -4 0 -8c0 -3 -19 -45 -45 -98c-24 -51 -46 -99 -49 -106c-24 -60 -24 -112 0 -148c4 -5 17 -21 30 -35l24 -26h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-25 28c-35 39 -42 50 -49 77 c-5 20 -6 37 -4 60c4 30 12 59 26 92c6 13 89 190 92 196c4 5 11 13 16 16z" id="glyph633" /> <glyph glyph-name="flags.mensuralu04" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l38 -44c45 -53 44 -52 49 -62c13 -27 11 -61 -3 -105c-4 -10 -120 -309 -122 -311c0 -1 1 -1 3 0h15c12 0 18 -1 29 -9c23 -15 43 -48 51 -85c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5 c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-1 3 -1 11 2 17c2 4 2 5 1 5c-3 1 -4 7 -4 11c1 2 27 70 59 151c65 167 63 162 67 179c3 11 3 14 3 28c1 18 -1 25 -8 36c-2 3 -21 26 -41 50 l-38 45h-19c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8z" id="glyph635" /> <glyph glyph-name="flags.mensuralu14" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l10 -11c6 -6 13 -14 16 -17c29 -36 44 -84 42 -131c-3 -50 -18 -97 -48 -142c-8 -11 -45 -59 -64 -82c-8 -10 -15 -14 -21 -14c-3 0 -4 0 -6 3c-1 2 -1 5 -1 8c2 9 7 17 36 53c15 19 30 39 34 45c41 61 43 144 5 202c-8 11 -15 20 -26 31l-7 8h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM17 -374c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28 c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13z" id="glyph637" /> <glyph glyph-name="flags.mensuralu24" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l25 -28c35 -39 42 -50 49 -76c5 -21 6 -38 4 -61c-4 -30 -12 -59 -26 -91c-6 -14 -89 -191 -92 -196c-7 -12 -17 -20 -25 -20c-4 0 -4 0 -6 4c-1 3 -1 4 0 8c0 3 19 45 45 98c24 51 46 99 49 106c24 60 24 112 0 148c-4 5 -17 21 -30 35l-23 26h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM18 -435c8 2 24 1 31 -2c14 -5 29 -19 40 -35s20 -40 24 -61c9 -50 -16 -99 -63 -126c-5 -3 -16 -8 -23 -11c-8 -3 -19 -8 -25 -11c-7 -3 -13 -5 -14 -5c-9 0 -8 16 2 31c8 11 10 13 43 27c29 12 39 18 42 27 c2 7 3 23 1 34c-6 32 -23 62 -44 76c-13 9 -24 12 -34 8c-3 -1 -7 -2 -10 -3c-4 0 -4 0 -6 3c-2 5 -1 11 4 20c6 13 18 24 32 28z" id="glyph639" /> <glyph glyph-name="flags.mensurald04" unicode="" horiz-adv-x="0" d="M-13 739c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c1 -3 1 -11 -2 -17c-2 -4 -2 -5 -1 -5c3 -1 4 -7 4 -11c-1 -2 -27 -70 -59 -151 c-65 -167 -63 -162 -67 -179c-3 -11 -3 -14 -3 -28c-1 -18 1 -25 8 -36c2 -3 21 -26 42 -50l38 -45h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-38 44c-45 53 -44 52 -49 63c-13 26 -11 60 3 104c4 10 120 309 122 311c0 1 -1 1 -3 0h-14 c-13 0 -19 1 -30 9c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25z" id="glyph641" /> <glyph glyph-name="flags.mensurald14" unicode="" horiz-adv-x="0" d="M-13 614c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85 c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM2 370c4 2 6 3 10 3c3 0 4 0 6 -3c1 -2 1 -5 1 -8c-2 -9 -7 -17 -36 -53c-15 -19 -30 -39 -34 -45c-41 -61 -43 -144 -5 -202c8 -11 15 -20 26 -31l7 -8h19c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35 c-10 -10 -10 -10 -36 -10h-22l-10 11c-6 6 -13 14 -16 18c-29 35 -44 83 -42 130c2 33 10 66 23 97c13 28 25 46 58 89c34 42 37 45 42 49z" id="glyph643" /> <glyph glyph-name="flags.mensurald24" unicode="" horiz-adv-x="0" d="M-1 682c5 2 11 4 13 4c9 0 9 -16 -2 -31c-8 -11 -10 -13 -43 -27c-29 -12 -39 -18 -42 -27c-2 -7 -3 -23 -1 -34c6 -32 23 -62 44 -76c13 -9 24 -12 34 -8c3 1 7 2 10 3c4 0 4 0 6 -3c5 -11 -9 -35 -25 -43c-9 -5 -17 -6 -27 -6c-11 1 -18 3 -28 10c-25 16 -45 52 -51 90 c-9 49 16 98 63 125c5 3 16 8 25 12c8 3 19 8 24 11zM3 445c3 2 6 3 9 3c4 0 4 0 6 -4c1 -3 1 -4 0 -8c0 -3 -19 -45 -45 -98c-24 -51 -46 -99 -49 -106c-24 -60 -24 -112 0 -148c4 -5 17 -21 30 -35l24 -26h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35 c-10 -10 -10 -10 -36 -10h-22l-25 28c-35 39 -42 50 -49 77c-5 20 -6 37 -4 60c4 30 12 59 26 92c6 13 89 190 92 196c4 5 11 13 16 16z" id="glyph645" /> <glyph glyph-name="flags.mensuralu05" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l38 -44c45 -53 44 -52 49 -62c13 -27 11 -61 -3 -105c-4 -10 -120 -309 -122 -311c0 -1 1 -1 3 0h15c12 0 18 -1 29 -9c23 -15 43 -48 51 -85c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5 c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-1 3 -1 11 2 17c2 4 2 5 1 5c-3 1 -4 7 -4 11c1 2 27 70 59 151c65 167 63 162 67 179c3 11 3 14 3 28c1 18 -1 25 -8 36c-2 3 -21 26 -41 50 l-38 45h-19c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM17 -749c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11 c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13z" id="glyph647" /> <glyph glyph-name="flags.mensuralu15" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l10 -11c6 -6 13 -14 16 -17c29 -36 44 -84 42 -131c-3 -50 -18 -97 -48 -142c-8 -11 -45 -59 -64 -82c-8 -10 -15 -14 -21 -14c-3 0 -4 0 -6 3c-1 2 -1 5 -1 8c2 9 7 17 36 53c15 19 30 39 34 45c41 61 43 144 5 202c-8 11 -15 20 -26 31l-7 8h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM17 -374c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28 c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13zM17 -624c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39 c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13z" id="glyph649" /> <glyph glyph-name="flags.mensuralu25" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l25 -28c35 -39 42 -50 49 -76c5 -21 6 -38 4 -61c-4 -30 -12 -59 -26 -91c-6 -14 -89 -191 -92 -196c-7 -12 -17 -20 -25 -20c-4 0 -4 0 -6 4c-1 3 -1 4 0 8c0 3 19 45 45 98c24 51 46 99 49 106c24 60 24 112 0 148c-4 5 -17 21 -30 35l-23 26h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM18 -435c8 2 24 1 31 -2c14 -5 29 -19 40 -35s20 -40 24 -61c9 -50 -16 -99 -63 -126c-5 -3 -16 -8 -23 -11c-8 -3 -19 -8 -25 -11c-7 -3 -13 -5 -14 -5c-9 0 -8 16 2 31c8 11 10 13 43 27c29 12 39 18 42 27 c2 7 3 23 1 34c-6 32 -23 62 -44 76c-13 9 -24 12 -34 8c-3 -1 -7 -2 -10 -3c-4 0 -4 0 -6 3c-2 5 -1 11 4 20c6 13 18 24 32 28zM18 -685c8 2 24 1 31 -2c14 -5 29 -19 40 -35s20 -40 24 -61c9 -50 -16 -99 -63 -126c-5 -3 -16 -8 -23 -11c-8 -3 -19 -8 -25 -11 c-7 -3 -13 -5 -14 -5c-9 0 -8 16 2 31c8 11 10 13 43 27c29 12 39 18 42 27c2 7 3 23 1 34c-6 32 -23 62 -44 76c-13 9 -24 12 -34 8c-3 -1 -7 -2 -10 -3c-4 0 -4 0 -6 3c-2 5 -1 11 4 20c6 13 18 24 32 28z" id="glyph651" /> <glyph glyph-name="flags.mensurald05" unicode="" horiz-adv-x="0" d="M-13 989c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85 c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM-13 739c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c1 -3 1 -11 -2 -17c-2 -4 -2 -5 -1 -5 c3 -1 4 -7 4 -11c-1 -2 -27 -70 -59 -151c-65 -167 -63 -162 -67 -179c-3 -11 -3 -14 -3 -28c-1 -18 1 -25 8 -36c2 -3 21 -26 42 -50l38 -45h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-38 44c-45 53 -44 52 -49 63c-13 26 -11 60 3 104 c4 10 120 309 122 311c0 1 -1 1 -3 0h-14c-13 0 -19 1 -30 9c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25z" id="glyph653" /> <glyph glyph-name="flags.mensurald15" unicode="" horiz-adv-x="0" d="M-13 864c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85 c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM-13 614c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15 c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM2 370c4 2 6 3 10 3c3 0 4 0 6 -3c1 -2 1 -5 1 -8c-2 -9 -7 -17 -36 -53c-15 -19 -30 -39 -34 -45c-41 -61 -43 -144 -5 -202c8 -11 15 -20 26 -31l7 -8h19c18 0 19 0 21 -2 c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-10 11c-6 6 -13 14 -16 18c-29 35 -44 83 -42 130c2 33 10 66 23 97c13 28 25 46 58 89c34 42 37 45 42 49z" id="glyph655" /> <glyph glyph-name="flags.mensurald25" unicode="" horiz-adv-x="0" d="M-1 932c5 2 11 4 13 4c9 0 9 -16 -2 -31c-8 -11 -10 -13 -43 -27c-29 -12 -39 -18 -42 -27c-2 -7 -3 -23 -1 -34c6 -32 23 -62 44 -76c13 -9 24 -12 34 -8c3 1 7 2 10 3c4 0 4 0 6 -3c5 -11 -9 -35 -25 -43c-9 -5 -17 -6 -27 -6c-11 1 -18 3 -28 10c-25 16 -45 52 -51 90 c-9 49 16 98 63 125c5 3 16 8 25 12c8 3 19 8 24 11zM-1 682c5 2 11 4 13 4c9 0 9 -16 -2 -31c-8 -11 -10 -13 -43 -27c-29 -12 -39 -18 -42 -27c-2 -7 -3 -23 -1 -34c6 -32 23 -62 44 -76c13 -9 24 -12 34 -8c3 1 7 2 10 3c4 0 4 0 6 -3c5 -11 -9 -35 -25 -43 c-9 -5 -17 -6 -27 -6c-11 1 -18 3 -28 10c-25 16 -45 52 -51 90c-9 49 16 98 63 125c5 3 16 8 25 12c8 3 19 8 24 11zM3 445c3 2 6 3 9 3c4 0 4 0 6 -4c1 -3 1 -4 0 -8c0 -3 -19 -45 -45 -98c-24 -51 -46 -99 -49 -106c-24 -60 -24 -112 0 -148c4 -5 17 -21 30 -35l24 -26 h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-25 28c-35 39 -42 50 -49 77c-5 20 -6 37 -4 60c4 30 12 59 26 92c6 13 89 190 92 196c4 5 11 13 16 16z" id="glyph657" /> <glyph glyph-name="flags.mensuralu06" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l38 -44c45 -53 44 -52 49 -62c13 -27 11 -61 -3 -105c-4 -10 -120 -309 -122 -311c0 -1 1 -1 3 0h15c12 0 18 -1 29 -9c23 -15 43 -48 51 -85c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5 c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-1 3 -1 11 2 17c2 4 2 5 1 5c-3 1 -4 7 -4 11c1 2 27 70 59 151c65 167 63 162 67 179c3 11 3 14 3 28c1 18 -1 25 -8 36c-2 3 -21 26 -41 50 l-38 45h-19c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM17 -749c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11 c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13zM17 -999c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39 c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-8 30 -23 54 -42 67c-13 9 -24 12 -35 8c-3 -1 -8 -2 -9 -2c-3 0 -4 1 -6 3c-2 5 -1 11 4 20c6 13 17 22 31 26z" id="glyph659" /> <glyph glyph-name="flags.mensuralu16" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l10 -11c6 -6 13 -14 16 -17c29 -36 44 -84 42 -131c-3 -50 -18 -97 -48 -142c-8 -11 -45 -59 -64 -82c-8 -10 -15 -14 -21 -14c-3 0 -4 0 -6 3c-1 2 -1 5 -1 8c2 9 7 17 36 53c15 19 30 39 34 45c41 61 43 144 5 202c-8 11 -15 20 -26 31l-7 8h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM17 -374c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28 c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13zM17 -624c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39 c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13zM17 -874c8 3 24 2 32 -1c14 -5 29 -19 40 -35c10 -14 19 -37 24 -57 c2 -12 2 -35 -1 -48c-5 -23 -17 -44 -35 -61c-14 -14 -30 -23 -67 -39c-22 -9 -25 -10 -28 -5c-5 10 9 34 25 42c3 2 14 7 23 11c30 12 41 19 44 28c3 7 3 30 0 43c-11 42 -37 73 -65 77c-4 0 -7 0 -14 -3c-9 -3 -10 -2 -13 2c-3 6 3 22 12 33c6 6 13 10 23 13z" id="glyph661" /> <glyph glyph-name="flags.mensuralu26" unicode="" horiz-adv-x="150" d="M5 22c3 2 6 2 26 2h22l25 -28c35 -39 42 -50 49 -76c5 -21 6 -38 4 -61c-4 -30 -12 -59 -26 -91c-6 -14 -89 -191 -92 -196c-7 -12 -17 -20 -25 -20c-4 0 -4 0 -6 4c-1 3 -1 4 0 8c0 3 19 45 45 98c24 51 46 99 49 106c24 60 24 112 0 148c-4 5 -17 21 -30 35l-23 26h-19 c-18 0 -19 0 -21 2c-5 6 1 23 12 35c4 3 8 7 10 8zM18 -435c8 2 24 1 31 -2c14 -5 29 -19 40 -35s20 -40 24 -61c9 -50 -16 -99 -63 -126c-5 -3 -16 -8 -23 -11c-8 -3 -19 -8 -25 -11c-7 -3 -13 -5 -14 -5c-9 0 -8 16 2 31c8 11 10 13 43 27c29 12 39 18 42 27 c2 7 3 23 1 34c-6 32 -23 62 -44 76c-13 9 -24 12 -34 8c-3 -1 -7 -2 -10 -3c-4 0 -4 0 -6 3c-2 5 -1 11 4 20c6 13 18 24 32 28zM18 -685c8 2 24 1 31 -2c14 -5 29 -19 40 -35s20 -40 24 -61c9 -50 -16 -99 -63 -126c-5 -3 -16 -8 -23 -11c-8 -3 -19 -8 -25 -11 c-7 -3 -13 -5 -14 -5c-9 0 -8 16 2 31c8 11 10 13 43 27c29 12 39 18 42 27c2 7 3 23 1 34c-6 32 -23 62 -44 76c-13 9 -24 12 -34 8c-3 -1 -7 -2 -10 -3c-4 0 -4 0 -6 3c-2 5 -1 11 4 20c6 13 18 24 32 28zM18 -935c8 2 24 1 31 -2c14 -5 29 -19 40 -35s20 -40 24 -61 c9 -50 -16 -99 -63 -126c-5 -3 -16 -8 -23 -11c-8 -3 -19 -8 -25 -11c-7 -3 -13 -5 -14 -5c-9 0 -8 16 2 31c8 11 10 13 43 27c29 12 39 18 42 27c2 7 3 23 1 34c-6 32 -23 62 -44 76c-13 9 -24 12 -34 8c-3 -1 -7 -2 -10 -3c-4 0 -4 0 -6 3c-2 5 -1 11 4 20 c6 13 18 24 32 28z" id="glyph663" /> <glyph glyph-name="flags.mensurald06" unicode="" horiz-adv-x="0" d="M-13 1239c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c8 -31 23 -55 42 -68c13 -9 24 -12 35 -8c3 1 8 2 9 2c3 0 4 -1 6 -3c5 -10 -9 -34 -24 -42c-9 -5 -17 -6 -28 -6c-11 1 -18 3 -28 10 c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM-13 989c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33 c-10 -11 -23 -16 -40 -15c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM-13 739c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78 c4 0 7 0 14 3c9 3 10 2 13 -2c1 -3 1 -11 -2 -17c-2 -4 -2 -5 -1 -5c3 -1 4 -7 4 -11c-1 -2 -27 -70 -59 -151c-65 -167 -63 -162 -67 -179c-3 -11 -3 -14 -3 -28c-1 -18 1 -25 8 -36c2 -3 21 -26 42 -50l38 -45h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35 c-10 -10 -10 -10 -36 -10h-22l-38 44c-45 53 -44 52 -49 63c-13 26 -11 60 3 104c4 10 120 309 122 311c0 1 -1 1 -3 0h-14c-13 0 -19 1 -30 9c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25z" id="glyph665" /> <glyph glyph-name="flags.mensurald16" unicode="" horiz-adv-x="0" d="M-13 1114c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85 c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM-13 864c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15 c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM-13 614c24 10 28 11 31 6c5 -10 -9 -34 -25 -42c-3 -2 -14 -7 -22 -11c-31 -12 -42 -19 -45 -28c-3 -7 -3 -30 0 -42c11 -43 37 -74 65 -78c4 0 7 0 14 3c9 3 10 2 13 -2 c3 -6 -3 -22 -12 -33c-10 -11 -23 -16 -40 -15c-11 1 -18 3 -28 10c-23 15 -43 48 -51 85c-2 12 -2 35 1 48c7 29 24 56 50 74c9 7 21 13 49 25zM2 370c4 2 6 3 10 3c3 0 4 0 6 -3c1 -2 1 -5 1 -8c-2 -9 -7 -17 -36 -53c-15 -19 -30 -39 -34 -45c-41 -61 -43 -144 -5 -202 c8 -11 15 -20 26 -31l7 -8h19c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-10 11c-6 6 -13 14 -16 18c-29 35 -44 83 -42 130c2 33 10 66 23 97c13 28 25 46 58 89c34 42 37 45 42 49z" id="glyph667" /> <glyph glyph-name="flags.mensurald26" unicode="" horiz-adv-x="0" d="M-1 1182c5 2 11 4 13 4c9 0 9 -16 -2 -31c-8 -11 -10 -13 -43 -27c-29 -12 -39 -18 -42 -27c-2 -7 -3 -23 -1 -34c6 -32 23 -62 44 -76c13 -9 24 -12 34 -8c3 1 7 2 10 3c4 0 4 0 6 -3c5 -11 -9 -35 -25 -43c-9 -5 -17 -6 -27 -6c-11 1 -18 3 -28 10 c-25 16 -45 52 -51 90c-9 49 16 98 63 125c5 3 16 8 25 12c8 3 19 8 24 11zM-1 932c5 2 11 4 13 4c9 0 9 -16 -2 -31c-8 -11 -10 -13 -43 -27c-29 -12 -39 -18 -42 -27c-2 -7 -3 -23 -1 -34c6 -32 23 -62 44 -76c13 -9 24 -12 34 -8c3 1 7 2 10 3c4 0 4 0 6 -3 c5 -11 -9 -35 -25 -43c-9 -5 -17 -6 -27 -6c-11 1 -18 3 -28 10c-25 16 -45 52 -51 90c-9 49 16 98 63 125c5 3 16 8 25 12c8 3 19 8 24 11zM-1 682c5 2 11 4 13 4c9 0 9 -16 -2 -31c-8 -11 -10 -13 -43 -27c-29 -12 -39 -18 -42 -27c-2 -7 -3 -23 -1 -34 c6 -32 23 -62 44 -76c13 -9 24 -12 34 -8c3 1 7 2 10 3c4 0 4 0 6 -3c5 -11 -9 -35 -25 -43c-9 -5 -17 -6 -27 -6c-11 1 -18 3 -28 10c-25 16 -45 52 -51 90c-9 49 16 98 63 125c5 3 16 8 25 12c8 3 19 8 24 11zM3 445c3 2 6 3 9 3c4 0 4 0 6 -4c1 -3 1 -4 0 -8 c0 -3 -19 -45 -45 -98c-24 -51 -46 -99 -49 -106c-24 -60 -24 -112 0 -148c4 -5 17 -21 30 -35l24 -26h18c18 0 19 0 21 -2c5 -6 -1 -23 -12 -35c-10 -10 -10 -10 -36 -10h-22l-25 28c-35 39 -42 50 -49 77c-5 20 -6 37 -4 60c4 30 12 59 26 92c6 13 89 190 92 196 c4 5 11 13 16 16z" id="glyph669" /> <glyph glyph-name="timesig.mensural44" unicode="" horiz-adv-x="425" d="M195 193c11 1 42 0 54 -1c39 -6 73 -19 102 -41c12 -10 20 -17 20 -19c-4 -5 -30 -8 -44 -4c-3 1 -7 5 -14 11c-36 31 -81 47 -117 41c-12 -2 -31 -9 -42 -15c-37 -17 -66 -47 -84 -84c-25 -52 -25 -110 0 -161c22 -46 59 -79 105 -94c16 -6 28 -7 43 -7 c31 2 66 17 95 42c7 6 11 10 14 11c14 4 40 1 44 -4c0 -2 -8 -9 -20 -19c-30 -22 -65 -36 -106 -41c-15 -2 -52 -2 -66 0c-57 9 -101 32 -134 71c-59 70 -59 172 0 243c36 42 87 67 150 71z" id="glyph671" /> <glyph glyph-name="timesig.mensural22" unicode="" horiz-adv-x="425" d="M143 317c2 2 3 2 45 2c50 0 46 1 50 -11c4 -13 1 -28 -9 -50c-13 -28 -16 -37 -16 -53v-11h12c51 -3 91 -17 126 -43c12 -10 20 -17 20 -19c-4 -5 -30 -8 -44 -4c-3 1 -7 5 -14 11c-27 23 -62 40 -92 42h-8v-181v-181h8c30 2 65 19 92 42c7 6 11 10 14 11 c14 4 40 1 44 -4c0 -2 -8 -9 -20 -19c-35 -26 -75 -40 -126 -43h-12v-60v-59l-3 -3l-3 -3h-19h-19l-3 3l-3 3v62v62l-10 2c-42 10 -81 33 -108 66c-59 70 -59 172 0 243c27 32 66 55 108 65l10 2v13c0 20 -2 27 -16 56c-10 22 -13 37 -9 50c1 5 3 8 5 9zM163 0v170 c-2 0 -22 -11 -29 -15c-50 -33 -83 -94 -83 -155c0 -57 29 -114 75 -148c7 -6 24 -16 31 -19l6 -3v170z" id="glyph673" /> <glyph glyph-name="timesig.mensural32" unicode="" horiz-adv-x="425" d="M195 193c10 1 42 0 53 -1c44 -7 79 -22 110 -47c66 -56 86 -149 48 -227c-15 -32 -37 -57 -68 -77c-25 -17 -54 -27 -90 -33c-17 -2 -53 -2 -69 0c-45 7 -80 22 -110 47c-80 67 -91 187 -24 267c36 42 86 66 150 71zM231 179c-18 4 -36 2 -56 -5 c-46 -15 -83 -48 -105 -93c-25 -52 -25 -110 0 -161c22 -46 59 -79 105 -94c28 -9 48 -9 76 0c46 15 83 48 105 94c15 31 22 66 18 99c-7 63 -46 119 -101 146c-12 6 -31 12 -42 14z" id="glyph675" /> <glyph glyph-name="timesig.mensural64" unicode="" horiz-adv-x="425" d="M195 193c11 1 42 0 54 -1c39 -6 73 -19 102 -41c12 -10 20 -17 20 -19c-4 -5 -30 -8 -44 -4c-3 1 -7 5 -14 11c-36 31 -81 47 -117 41c-12 -2 -31 -9 -42 -15c-37 -17 -66 -47 -84 -84c-25 -52 -25 -110 0 -161c22 -46 59 -79 105 -94c16 -6 28 -7 43 -7 c31 2 66 17 95 42c7 6 11 10 14 11c14 4 40 1 44 -4c0 -2 -8 -9 -20 -19c-30 -22 -65 -36 -106 -41c-15 -2 -52 -2 -66 0c-57 9 -101 32 -134 71c-59 70 -59 172 0 243c36 42 87 67 150 71zM201 48c27 7 55 -10 61 -38c7 -35 -26 -67 -61 -58c-9 2 -16 6 -23 13 c-20 20 -20 50 0 70c7 7 14 11 23 13z" id="glyph677" /> <glyph glyph-name="timesig.mensural94" unicode="" horiz-adv-x="425" d="M195 193c10 1 42 0 53 -1c44 -7 79 -22 110 -47c66 -56 86 -149 48 -227c-15 -32 -37 -57 -68 -77c-25 -17 -54 -27 -90 -33c-17 -2 -53 -2 -69 0c-45 7 -80 22 -110 47c-80 67 -91 187 -24 267c36 42 86 66 150 71zM231 179c-18 4 -36 2 -56 -5 c-46 -15 -83 -48 -105 -93c-25 -52 -25 -110 0 -161c22 -46 59 -79 105 -94c28 -9 48 -9 76 0c46 15 83 48 105 94c15 31 22 66 18 99c-7 63 -46 119 -101 146c-12 6 -31 12 -42 14zM201 48c27 7 55 -10 61 -38c7 -35 -26 -67 -61 -58c-9 2 -16 6 -23 13c-20 20 -20 50 0 70 c7 7 14 11 23 13z" id="glyph679" /> <glyph glyph-name="timesig.mensural34" unicode="" horiz-adv-x="425" d="M168 317c2 2 3 2 45 2c50 0 46 1 50 -11c4 -13 1 -28 -9 -50c-14 -28 -16 -36 -16 -54c0 -13 -2 -11 13 -13c40 -5 77 -21 107 -46c79 -67 90 -187 23 -266c-32 -38 -78 -63 -130 -70c-5 -1 -10 -1 -11 -2h-2v-60v-60l-3 -3l-3 -3h-19h-19l-3 3l-3 3v60v60h-2 c-1 1 -6 1 -11 2c-38 5 -76 21 -104 44c-68 56 -89 150 -51 230c29 59 86 99 155 108c15 2 13 0 13 13c0 18 -2 26 -16 54c-10 22 -13 37 -9 50c1 5 3 8 5 9zM188 0c0 98 0 178 -1 178c-2 0 -26 -9 -34 -13c-61 -30 -102 -96 -102 -165s41 -136 102 -165c9 -4 25 -11 32 -12 l3 -1v178zM254 173c-6 2 -12 4 -13 4l-3 1v-178v-178l3 1c7 1 23 8 32 12c67 32 109 110 101 184c-8 71 -55 132 -120 154z" id="glyph681" /> <glyph glyph-name="timesig.mensural68" unicode="" horiz-adv-x="425" d="M168 317c2 2 3 2 45 2c50 0 46 1 50 -11c4 -13 1 -28 -9 -50c-14 -28 -16 -36 -16 -54c0 -11 0 -11 2 -11c1 -1 8 -2 14 -2c36 -5 69 -19 97 -40c12 -10 20 -17 20 -19c-4 -5 -30 -8 -44 -4c-3 1 -7 5 -14 11c-13 11 -24 19 -39 26c-11 5 -32 13 -35 13 c-1 0 -1 -18 -1 -67v-68l3 -1c1 -1 5 -5 9 -8c17 -20 17 -48 0 -68c-4 -3 -8 -7 -9 -8l-3 -1v-68c0 -49 0 -67 1 -67c3 0 24 8 35 13c15 7 26 15 39 26c7 6 11 10 14 11c14 4 40 1 44 -4c0 -2 -8 -9 -20 -19c-28 -21 -61 -35 -97 -40c-6 0 -13 -1 -14 -2h-2v-60v-60l-3 -3 l-3 -3h-19h-19l-3 3l-3 3v60v60h-2c-1 1 -6 1 -11 2c-52 7 -98 32 -130 70c-59 70 -59 172 0 243c32 37 78 62 130 69c15 2 13 0 13 13c0 18 -2 26 -16 54c-10 22 -13 37 -9 50c1 5 3 8 5 9zM188 111c0 37 0 67 -1 67l-12 -4c-46 -15 -83 -48 -105 -93 c-25 -52 -25 -110 0 -161c21 -45 58 -78 103 -93c5 -2 11 -4 12 -4l3 -1v67v68l-3 2c-6 3 -13 12 -16 18c-8 15 -8 31 0 46c3 6 10 15 16 18l3 2v68z" id="glyph683" /> <glyph glyph-name="timesig.mensural98" unicode="" horiz-adv-x="425" d="M168 317c2 2 3 2 45 2c50 0 46 1 50 -11c4 -13 1 -28 -9 -50c-14 -28 -16 -36 -16 -54c0 -13 -2 -11 13 -13c40 -5 77 -21 107 -46c79 -67 90 -187 23 -266c-32 -38 -78 -63 -130 -70c-5 -1 -10 -1 -11 -2h-2v-60v-60l-3 -3l-3 -3h-19h-19l-3 3l-3 3v60v60h-2 c-1 1 -6 1 -11 2c-38 5 -76 21 -104 44c-68 56 -89 150 -51 230c29 59 86 99 155 108c15 2 13 0 13 13c0 18 -2 26 -16 54c-10 22 -13 37 -9 50c1 5 3 8 5 9zM188 111c0 37 0 67 -1 67c-2 0 -26 -9 -34 -13c-61 -30 -102 -96 -102 -165s41 -136 102 -165c9 -4 25 -11 32 -12 l3 -1v67v68l-3 2c-6 3 -13 12 -16 18c-8 15 -8 31 0 46c3 6 10 15 16 18l3 2v68zM254 173c-6 2 -12 4 -13 4l-3 1v-67v-68l3 -1c5 -3 14 -14 17 -20c7 -15 7 -29 0 -44c-3 -6 -12 -17 -17 -20l-3 -1v-68v-67l3 1c7 1 23 8 32 12c67 32 109 110 101 184 c-8 71 -55 132 -120 154z" id="glyph685" /> <glyph glyph-name="timesig.mensural48" unicode="" horiz-adv-x="425" d="M190 193c13 1 44 0 58 -2c56 -7 100 -31 133 -69c59 -71 59 -173 0 -243c-33 -39 -77 -62 -133 -71c-15 -2 -52 -2 -66 0c-42 5 -77 19 -106 41c-13 10 -21 17 -21 19c4 5 30 8 44 4c3 -1 7 -5 14 -11c36 -31 81 -47 117 -41c20 4 42 13 61 25c51 33 84 94 84 155 c0 42 -16 86 -44 120c-22 25 -48 43 -80 54c-16 6 -28 7 -42 7c-32 -2 -67 -17 -96 -42c-7 -6 -11 -10 -14 -11c-14 -4 -40 -1 -44 4c0 2 8 9 21 19c31 24 68 38 114 42z" id="glyph687" /> <glyph glyph-name="timesig.mensural68alt" unicode="" horiz-adv-x="425" d="M190 193c13 1 44 0 58 -2c56 -7 100 -31 133 -69c59 -71 59 -173 0 -243c-33 -39 -77 -62 -133 -71c-15 -2 -52 -2 -66 0c-42 5 -77 19 -106 41c-13 10 -21 17 -21 19c4 5 30 8 44 4c3 -1 7 -5 14 -11c36 -31 81 -47 117 -41c20 4 42 13 61 25c51 33 84 94 84 155 c0 42 -16 86 -44 120c-22 25 -48 43 -80 54c-16 6 -28 7 -42 7c-32 -2 -67 -17 -96 -42c-7 -6 -11 -10 -14 -11c-14 -4 -40 -1 -44 4c0 2 8 9 21 19c31 24 68 38 114 42zM201 48c27 7 55 -10 61 -38c7 -35 -26 -67 -61 -58c-9 2 -16 6 -23 13c-20 20 -20 50 0 70 c7 7 14 11 23 13z" id="glyph689" /> <glyph glyph-name="timesig.mensural24" unicode="" horiz-adv-x="425" d="M143 317c2 2 3 2 45 2c50 0 46 1 50 -11c4 -13 1 -28 -9 -50c-13 -28 -16 -37 -16 -53v-11h12c67 -4 119 -28 156 -72c59 -71 59 -173 0 -243c-37 -45 -89 -69 -156 -73h-12v-60v-59l-3 -3l-3 -3h-19h-19l-3 3l-3 3v62v62l-8 1c-20 5 -45 15 -63 26c-15 9 -38 28 -37 30 c4 5 30 8 44 4c3 -1 7 -5 14 -11c12 -10 24 -18 39 -26l11 -5v85v170v85l-11 -5c-15 -8 -27 -16 -39 -26c-7 -6 -11 -10 -14 -11c-14 -4 -40 -1 -44 4c-1 2 22 21 37 30c18 11 43 21 63 26l8 1v13c0 20 -2 27 -16 56c-10 22 -13 37 -9 50c1 5 3 8 5 9zM231 179 c-5 1 -11 2 -14 2h-4v-181v-181h4c13 0 38 7 55 16c37 17 66 47 84 85c25 51 25 109 0 161c-18 37 -47 67 -84 84c-11 6 -30 12 -41 14z" id="glyph691" /> <glyph glyph-name="timesig.neomensural44" unicode="" horiz-adv-x="425" d="M191 211c11 1 44 0 55 -1c43 -8 82 -27 112 -55c10 -9 12 -14 12 -22c0 -15 -10 -25 -24 -25c-9 0 -13 2 -23 11c-34 32 -81 47 -127 42c-71 -8 -130 -62 -143 -133c-2 -14 -2 -42 0 -55c13 -72 72 -126 143 -134c46 -5 93 10 127 42c10 9 14 11 23 11 c14 0 24 -10 24 -25c0 -8 -2 -13 -12 -22c-26 -24 -58 -42 -93 -50c-64 -17 -132 -2 -184 40c-31 24 -55 59 -68 97c-24 70 -10 145 38 204c34 41 84 68 140 75z" id="glyph693" /> <glyph glyph-name="timesig.neomensural22" unicode="" horiz-adv-x="425" d="M165 210l4 3h15c22 0 50 -2 62 -3c42 -7 82 -26 112 -55c10 -9 12 -14 12 -22c0 -15 -10 -25 -24 -25c-9 0 -13 2 -23 11c-25 23 -58 38 -92 42c-6 1 -12 1 -14 1h-4v-162v-162h4c2 0 8 0 14 1c34 4 67 19 92 42c10 9 14 11 23 11c14 0 24 -10 24 -25 c0 -8 -2 -13 -12 -22c-30 -29 -70 -48 -112 -55c-12 -1 -40 -3 -60 -3c-16 0 -20 1 -21 5c-1 1 -4 3 -14 6c-56 17 -103 57 -128 110c-37 74 -26 162 28 228c24 30 58 53 96 65c13 4 16 6 18 9zM163 0v154c-8 -3 -20 -8 -29 -13c-42 -24 -72 -66 -81 -113 c-2 -14 -2 -42 0 -55c6 -34 24 -67 49 -90c16 -15 37 -28 56 -35l5 -2v154z" id="glyph695" /> <glyph glyph-name="timesig.neomensural32" unicode="" horiz-adv-x="425" d="M188 210c5 1 16 2 24 2c48 0 95 -16 134 -47c30 -24 54 -59 67 -97c24 -69 11 -143 -35 -200c-39 -50 -102 -80 -165 -80c-48 0 -95 17 -134 49c-55 44 -86 119 -76 188c5 42 20 77 47 110c33 41 82 68 138 75zM241 159c-9 2 -36 3 -42 2c-30 -4 -47 -9 -67 -21 c-41 -25 -70 -66 -79 -112c-2 -14 -2 -42 0 -55c12 -68 65 -121 133 -133c13 -2 41 -2 55 0c67 12 120 65 132 133c2 13 2 41 0 55c-12 66 -66 120 -132 131z" id="glyph697" /> <glyph glyph-name="timesig.neomensural64" unicode="" horiz-adv-x="425" d="M191 211c11 1 44 0 55 -1c43 -8 82 -27 112 -55c10 -9 12 -14 12 -22c0 -15 -10 -25 -24 -25c-9 0 -13 2 -23 11c-34 32 -81 47 -127 42c-71 -8 -130 -62 -143 -133c-2 -14 -2 -42 0 -55c13 -72 72 -126 143 -134c46 -5 93 10 127 42c10 9 14 11 23 11 c14 0 24 -10 24 -25c0 -8 -2 -13 -12 -22c-26 -24 -58 -42 -93 -50c-64 -17 -132 -2 -184 40c-31 24 -55 59 -68 97c-24 70 -10 145 38 204c34 41 84 68 140 75zM201 48c27 7 55 -10 61 -38c7 -35 -26 -67 -61 -58c-9 2 -16 6 -23 13c-20 20 -20 50 0 70c7 7 14 11 23 13z " id="glyph699" /> <glyph glyph-name="timesig.neomensural94" unicode="" horiz-adv-x="425" d="M188 210c5 1 16 2 24 2c48 0 95 -16 134 -47c30 -24 54 -59 67 -97c24 -69 11 -143 -35 -200c-39 -50 -102 -80 -165 -80c-48 0 -95 17 -134 49c-55 44 -86 119 -76 188c5 42 20 77 47 110c33 41 82 68 138 75zM241 159c-9 2 -36 3 -42 2c-30 -4 -47 -9 -67 -21 c-41 -25 -70 -66 -79 -112c-2 -14 -2 -42 0 -55c12 -68 65 -121 133 -133c13 -2 41 -2 55 0c67 12 120 65 132 133c2 13 2 41 0 55c-12 66 -66 120 -132 131zM201 48c27 7 55 -10 61 -38c7 -35 -26 -67 -61 -58c-9 2 -16 6 -23 13c-20 20 -20 50 0 70c7 7 14 11 23 13z" id="glyph701" /> <glyph glyph-name="timesig.neomensural34" unicode="" horiz-adv-x="425" d="M191 211c5 2 36 2 44 1c3 -1 11 -3 18 -4c24 -4 53 -16 74 -30c41 -27 71 -64 86 -110c24 -69 11 -143 -35 -200c-31 -39 -79 -68 -126 -76c-7 -1 -15 -3 -17 -4c-7 -2 -36 -2 -44 0c-3 1 -11 3 -18 4c-32 6 -66 22 -94 45c-55 44 -86 119 -76 188c5 42 20 77 47 110 c30 37 77 65 124 73c7 1 14 3 17 3zM188 0c0 127 0 160 -1 160c-4 0 -15 -3 -22 -6c-58 -18 -101 -67 -112 -126c-2 -14 -2 -42 0 -55c11 -60 54 -109 112 -127c6 -2 20 -6 23 -6v160zM246 158c-4 1 -7 2 -8 2v-160v-160c3 0 17 4 24 6c57 18 100 67 111 127c2 13 2 41 0 55 c-12 64 -63 117 -127 130z" id="glyph703" /> <glyph glyph-name="timesig.neomensural68" unicode="" horiz-adv-x="425" d="M191 212c6 2 38 1 53 -2c48 -9 83 -26 114 -55c10 -9 12 -14 12 -22c0 -15 -10 -25 -24 -25c-9 0 -13 2 -23 11c-16 15 -38 28 -57 34c-8 3 -24 7 -27 7c-1 0 -1 -12 -1 -58v-59l3 -1c5 -3 14 -14 17 -20c7 -15 7 -29 0 -44c-3 -6 -12 -17 -17 -20l-3 -1v-59 c0 -46 0 -58 1 -58c3 0 19 4 27 7c19 6 41 19 57 34c10 9 14 11 23 11c14 0 24 -10 24 -25c0 -8 -2 -13 -12 -22c-37 -35 -90 -56 -142 -58c-14 0 -19 0 -24 1c-4 1 -13 3 -19 4s-18 4 -26 7c-63 21 -113 70 -134 133c-24 70 -10 145 38 204c30 37 77 64 123 72 c7 1 14 3 17 4zM188 102c0 46 0 58 -1 58c-2 0 -23 -6 -29 -8c-54 -19 -94 -68 -105 -124c-2 -14 -2 -42 0 -55c11 -58 52 -107 107 -126c6 -2 25 -7 27 -7c1 0 1 26 1 58v59l-3 2c-6 3 -13 12 -16 18c-8 15 -8 31 0 46c3 6 10 15 16 18l3 2v59z" id="glyph705" /> <glyph glyph-name="timesig.neomensural98" unicode="" horiz-adv-x="425" d="M191 211c5 2 36 2 44 1c3 -1 11 -3 18 -4c24 -4 53 -16 74 -30c41 -27 71 -64 86 -110c24 -69 11 -143 -35 -200c-31 -39 -79 -68 -126 -76c-7 -1 -15 -3 -17 -4c-7 -2 -36 -2 -44 0c-3 1 -11 3 -18 4c-32 6 -66 22 -94 45c-55 44 -86 119 -76 188c5 42 20 77 47 110 c30 37 77 65 124 73c7 1 14 3 17 3zM188 102c0 46 0 58 -1 58c-4 0 -15 -3 -22 -6c-58 -18 -101 -67 -112 -126c-2 -14 -2 -42 0 -55c11 -60 54 -109 112 -127c6 -2 20 -6 23 -6v58v59l-3 2c-6 3 -13 12 -16 18c-8 15 -8 31 0 46c3 6 10 15 16 18l3 2v59zM246 158 c-4 1 -7 2 -8 2v-58v-59l3 -1c1 -1 5 -5 9 -8c17 -20 17 -48 0 -68c-4 -3 -8 -7 -9 -8l-3 -1v-59v-58c3 0 17 4 24 6c57 18 100 67 111 127c2 13 2 41 0 55c-12 64 -63 117 -127 130z" id="glyph707" /> <glyph glyph-name="timesig.neomensural48" unicode="" horiz-adv-x="425" d="M195 211c6 1 30 1 39 0c41 -5 79 -20 112 -46c30 -24 54 -59 67 -97c24 -70 10 -145 -38 -203c-30 -37 -75 -64 -121 -73c-68 -13 -137 7 -186 53c-10 9 -12 14 -12 22c0 15 10 25 25 25c8 0 12 -2 22 -11c34 -32 81 -47 127 -42c71 8 130 62 143 134c2 13 2 41 0 55 c-16 84 -93 142 -178 133c-34 -4 -67 -19 -92 -42c-10 -9 -14 -11 -22 -11c-15 0 -25 10 -25 25c0 8 2 13 12 22c15 14 36 28 54 37c18 8 43 16 62 18c4 1 10 1 11 1z" id="glyph709" /> <glyph glyph-name="timesig.neomensural68alt" unicode="" horiz-adv-x="425" d="M195 211c6 1 30 1 39 0c41 -5 79 -20 112 -46c30 -24 54 -59 67 -97c24 -70 10 -145 -38 -203c-30 -37 -75 -64 -121 -73c-68 -13 -137 7 -186 53c-10 9 -12 14 -12 22c0 15 10 25 25 25c8 0 12 -2 22 -11c34 -32 81 -47 127 -42c71 8 130 62 143 134c2 13 2 41 0 55 c-16 84 -93 142 -178 133c-34 -4 -67 -19 -92 -42c-10 -9 -14 -11 -22 -11c-15 0 -25 10 -25 25c0 8 2 13 12 22c15 14 36 28 54 37c18 8 43 16 62 18c4 1 10 1 11 1zM201 48c27 7 55 -10 61 -38c7 -35 -26 -67 -61 -58c-9 2 -16 6 -23 13c-20 20 -20 50 0 70 c7 7 14 11 23 13z" id="glyph711" /> <glyph glyph-name="timesig.neomensural24" unicode="" horiz-adv-x="425" d="M165 209l4 4h28c41 -1 57 -4 82 -12c54 -18 99 -57 124 -108c37 -75 26 -163 -28 -228c-34 -43 -85 -70 -141 -76c-5 -1 -22 -1 -36 -2c-29 0 -31 0 -33 5c-1 1 -3 2 -6 3c-9 2 -27 9 -37 13c-18 9 -39 23 -54 37c-10 9 -12 14 -12 22c0 15 10 25 25 25c8 0 12 -2 22 -11 c15 -14 37 -27 54 -33c3 -1 5 -2 6 -2v154v154c-1 0 -3 -1 -6 -2c-17 -6 -39 -19 -54 -33c-10 -9 -14 -11 -22 -11c-15 0 -25 10 -25 25c0 8 2 13 12 22c15 14 36 28 54 37c10 4 34 13 37 13c1 0 4 2 6 4zM230 161c-6 1 -12 1 -13 1h-4v-162v-162h4c1 0 7 0 13 1 c71 8 130 62 143 134c2 13 2 41 0 55c-13 71 -72 125 -143 133z" id="glyph713" /> <glyph glyph-name="scripts.ictus" unicode="" horiz-adv-x="13" d="M-4 43c4 1 5 1 8 0c2 0 4 -2 6 -3l3 -3v-37v-37l-3 -3c-5 -5 -14 -5 -19 0l-3 3v37v37l3 3c2 2 4 3 5 3z" id="glyph715" /> <glyph glyph-name="scripts.uaccentus" unicode="" horiz-adv-x="31" d="M11 43c3 1 10 1 14 -2s6 -8 6 -13c-1 -4 -4 -10 -21 -36c-20 -33 -22 -36 -28 -36c-7 0 -13 6 -13 13c0 1 6 14 18 35c9 19 18 34 19 35s3 3 5 4z" id="glyph717" /> <glyph glyph-name="scripts.daccentus" unicode="" horiz-adv-x="31" d="M-25 42c4 2 9 3 13 0c4 -2 42 -64 43 -69c1 -11 -8 -19 -19 -16c-2 0 -5 2 -6 3c-3 4 -37 68 -37 71c0 4 3 9 6 11z" id="glyph719" /> <glyph glyph-name="scripts.usemicirculus" unicode="" horiz-adv-x="39" d="M-11 37c24 7 46 -8 50 -32v-5h-7c-8 0 -8 0 -8 2c0 4 -4 12 -8 15c-4 4 -11 7 -16 7s-13 -4 -17 -8c-3 -3 -7 -11 -7 -14c0 -2 0 -2 -8 -2h-7v5c3 16 14 29 28 32z" id="glyph721" /> <glyph glyph-name="scripts.dsemicirculus" unicode="" horiz-adv-x="39" d="M-39 -5v5h7c8 0 8 0 8 -2c0 -3 4 -11 7 -14c4 -4 12 -8 17 -8s12 3 16 7c4 3 8 11 8 15c0 2 0 2 8 2h7v-5c-4 -24 -26 -39 -50 -32c-14 3 -25 16 -28 32z" id="glyph723" /> <glyph glyph-name="scripts.circulus" unicode="" horiz-adv-x="39" d="M-11 37c7 2 18 2 25 0c2 -1 7 -4 10 -6c16 -13 20 -38 7 -54c-13 -17 -38 -21 -54 -8c-17 13 -21 38 -8 55c5 6 13 11 20 13zM9 22c-6 3 -12 3 -18 0c-20 -9 -20 -35 0 -44c6 -3 12 -3 19 0c12 6 17 20 12 32c-3 6 -7 9 -13 12z" id="glyph725" /> <glyph glyph-name="scripts.augmentum" unicode="" horiz-adv-x="31" d="M-11 29c6 3 19 2 25 -1c5 -3 11 -9 14 -14c2 -4 2 -6 2 -14c0 -11 -1 -15 -8 -22c-6 -6 -11 -8 -20 -9c-10 0 -16 2 -24 9c-9 10 -11 21 -7 33c2 6 12 16 18 18z" id="glyph727" /> <glyph glyph-name="scripts.usignumcongruentiae" unicode="" horiz-adv-x="163" d="M86 569c13 2 35 2 45 0c9 -3 19 -9 26 -14l5 -5v-5c-2 -20 -40 -76 -61 -92c-9 -6 -10 -6 -16 -1c-6 6 -17 11 -25 14c-4 0 -11 1 -16 2c-24 1 -63 -11 -103 -33c-13 -7 -28 -17 -29 -18c-1 -2 -1 -18 0 -27c5 -33 27 -66 59 -87c4 -3 20 -11 35 -19c16 -8 31 -16 34 -18 c38 -22 60 -60 63 -103c1 -32 -9 -67 -34 -107c-27 -46 -60 -82 -91 -102c-6 -4 -9 -5 -11 -5c-3 0 -4 1 -4 4c-1 7 9 27 23 48c11 17 19 27 32 39l10 10v10c0 33 -12 62 -33 84c-14 13 -21 18 -57 36c-29 14 -38 19 -50 28c-31 26 -50 61 -52 98c-1 28 10 62 33 100 c28 47 63 86 101 111c36 25 85 46 116 52zM-136 36c7 2 14 2 22 0c12 -4 21 -13 25 -25c3 -8 3 -14 0 -22c-5 -16 -20 -27 -36 -27c-7 0 -17 3 -22 8c-10 6 -16 19 -16 30c0 16 11 31 27 36zM114 36c7 2 14 2 22 0c12 -4 21 -13 25 -25c3 -8 3 -14 0 -22 c-5 -16 -20 -27 -36 -27c-7 0 -17 3 -22 8c-10 6 -16 19 -16 30c0 16 11 31 27 36z" id="glyph729" /> <glyph glyph-name="scripts.dsignumcongruentiae" unicode="" horiz-adv-x="163" d="M22 46c6 4 9 5 11 5c3 0 4 -1 4 -4c1 -7 -9 -27 -23 -48c-11 -17 -19 -27 -32 -39l-10 -10v-10c0 -33 12 -62 33 -84c14 -13 21 -18 57 -36c29 -14 38 -19 50 -28c38 -32 58 -78 50 -122c-7 -39 -32 -86 -72 -132c-29 -35 -61 -59 -106 -81c-41 -21 -70 -29 -96 -28 c-7 1 -15 2 -18 2c-10 3 -20 8 -27 14l-5 5v5c2 20 40 76 61 92c9 6 10 6 16 1c6 -6 17 -11 26 -14c3 0 10 -1 15 -2c24 -1 63 11 103 33c13 7 28 17 29 18c1 2 1 18 0 27c-5 33 -27 66 -59 87c-4 3 -20 11 -35 19c-16 8 -31 16 -34 18c-38 22 -60 60 -63 103 c-1 32 9 67 34 107c27 46 60 82 91 102zM-136 36c7 2 14 2 22 0c16 -5 27 -20 27 -36s-11 -31 -27 -36c-8 -3 -14 -3 -22 0c-16 5 -27 20 -27 36s11 31 27 36zM114 36c7 2 14 2 22 0c16 -5 27 -20 27 -36s-11 -31 -27 -36c-8 -3 -14 -3 -22 0c-16 5 -27 20 -27 36 s11 31 27 36z" id="glyph731" /> <glyph glyph-name="dots.dotvaticana" unicode="" horiz-adv-x="75" d="M26 36c8 3 19 2 28 -2c8 -4 15 -11 19 -19c2 -5 2 -7 2 -15c0 -9 0 -10 -3 -16c-4 -8 -11 -15 -19 -19c-5 -2 -7 -2 -15 -2c-9 0 -10 0 -16 3c-8 4 -15 11 -19 19c-2 5 -2 7 -2 15s0 10 2 15c5 10 12 17 23 21z" id="glyph733" /> <glyph glyph-name="space" unicode=" " horiz-adv-x="193" id="glyph735" /> <glyph glyph-name="plus" unicode="+" d="M117 374c9 3 23 -1 29 -9c5 -6 5 -8 5 -50v-39h39c42 0 44 0 50 -5c2 -2 5 -5 7 -8c2 -4 3 -6 3 -12c0 -7 -1 -9 -3 -13c-2 -3 -5 -6 -7 -8c-6 -5 -8 -5 -50 -5h-39v-40c0 -43 0 -44 -5 -50c-2 -2 -5 -5 -8 -7c-7 -4 -18 -4 -25 0c-3 2 -6 5 -8 7c-5 6 -5 7 -5 50v40h-40 c-43 0 -44 0 -50 5c-2 2 -5 5 -7 8c-2 4 -2 6 -2 13c0 6 0 8 2 12c2 3 5 6 7 8c6 5 7 5 50 5h40v41l1 41l2 4c3 6 8 10 14 12z" id="glyph737" /> <glyph glyph-name="comma" unicode="," horiz-adv-x="115" d="M47 114c2 1 8 1 13 1c15 -1 28 -6 38 -17c14 -14 19 -33 17 -62c-4 -51 -19 -101 -49 -168c-9 -20 -11 -22 -15 -25c-9 -4 -22 4 -22 14c0 1 2 6 3 10c2 4 8 17 13 28c20 43 25 68 18 86c-4 10 -8 14 -25 22c-12 6 -15 8 -21 14c-7 7 -11 14 -15 24c-2 8 -2 25 1 34 c7 20 23 34 44 39z" id="glyph739" /> <glyph glyph-name="hyphen" unicode="-" horiz-adv-x="167" d="M8 179c3 2 9 2 76 2c79 0 76 0 80 -6c3 -4 3 -13 0 -17c-4 -6 -1 -6 -80 -6c-67 0 -73 0 -76 2c-5 2 -7 6 -7 13c0 6 2 10 7 12z" id="glyph741" /> <glyph glyph-name="period" unicode="." horiz-adv-x="115" d="M43 113c20 5 41 -1 55 -15c8 -7 12 -16 15 -27c5 -19 -1 -40 -15 -54c-7 -8 -16 -12 -27 -15c-19 -5 -40 1 -54 15c-8 7 -12 16 -15 27c-5 19 1 40 15 54c7 8 16 12 26 15z" id="glyph743" /> <glyph glyph-name="zero" unicode="0" horiz-adv-x="367" d="M164 499c4 0 15 1 24 0c24 0 41 -4 63 -15c35 -17 63 -48 84 -90c16 -32 25 -66 30 -106c2 -15 2 -61 0 -75c-5 -41 -14 -75 -30 -106c-21 -43 -49 -74 -84 -91c-14 -7 -23 -10 -38 -13c-9 -2 -14 -2 -29 -2c-21 0 -31 1 -48 7c-11 3 -30 13 -40 20 c-51 37 -84 102 -94 185c-2 14 -2 60 0 75c5 40 14 74 30 106c30 60 76 97 132 105zM196 469c-9 2 -18 2 -26 0c-25 -6 -40 -31 -48 -75c-5 -29 -6 -57 -6 -160c1 -89 2 -104 7 -131c5 -28 14 -49 26 -61c19 -17 50 -17 69 0c12 12 21 33 26 61c5 27 6 42 7 131 c0 103 -1 131 -6 160c-5 30 -14 52 -27 64c-6 5 -15 10 -22 11z" id="glyph745" /> <glyph glyph-name="one" unicode="1" horiz-adv-x="318" d="M119 502c3 2 7 1 24 -6c26 -12 38 -12 64 0c6 3 12 5 13 5c4 0 9 -4 11 -8s2 -9 2 -191c0 -121 0 -190 1 -197c4 -39 25 -70 54 -79c3 -1 10 -2 14 -3c10 0 11 -1 14 -5c4 -6 2 -14 -4 -16c-6 -3 -25 -2 -71 5c-62 8 -70 8 -131 0c-47 -7 -66 -8 -72 -5c-6 2 -8 10 -4 16 c3 4 4 5 14 5c4 1 11 2 14 3c29 9 50 40 54 79c1 15 1 255 0 262c-3 12 -15 18 -23 11c-1 -1 -17 -33 -35 -72s-34 -71 -35 -72c-9 -10 -26 -3 -25 10c1 3 17 40 60 131c32 69 60 126 61 127z" id="glyph747" /> <glyph glyph-name="two" unicode="2" horiz-adv-x="367" d="M148 499c8 1 42 0 52 -1c24 -4 48 -11 68 -21c42 -21 70 -52 80 -92c3 -11 3 -13 3 -31c0 -21 0 -28 -5 -45c-9 -39 -34 -70 -75 -94c-20 -12 -40 -22 -92 -43c-11 -5 -28 -12 -37 -16c-17 -8 -37 -19 -37 -20c1 0 4 0 9 1c10 2 32 1 45 -2c25 -5 48 -15 74 -32 c16 -10 22 -14 34 -18c22 -8 43 -8 58 -1c10 5 15 11 19 23c2 7 6 10 11 10c6 0 12 -5 12 -11c0 -4 -6 -22 -10 -29c-19 -37 -56 -65 -99 -74c-8 -2 -14 -2 -27 -2c-19 -1 -27 1 -42 5c-21 7 -35 16 -53 34c-19 19 -29 25 -47 26c-19 1 -36 -6 -49 -18 c-9 -9 -13 -19 -16 -32c-2 -11 -3 -12 -7 -15c-6 -3 -14 0 -16 6c-3 7 3 36 11 56c10 26 30 53 57 76c14 12 23 20 49 39c61 45 84 68 101 101c5 10 11 28 13 39c9 41 2 96 -14 125c-14 24 -33 35 -57 34c-20 -2 -36 -10 -44 -23c-2 -5 -2 -7 -2 -13c0 -11 3 -18 17 -35 c6 -8 12 -16 14 -20c2 -5 2 -6 2 -16c0 -18 -6 -34 -20 -47c-6 -6 -10 -9 -17 -12c-21 -11 -40 -11 -61 0c-8 4 -11 6 -18 13c-6 6 -9 10 -12 17c-9 19 -10 39 -3 63c14 51 66 88 131 95z" id="glyph749" /> <glyph glyph-name="three" unicode="3" horiz-adv-x="333" d="M129 499c11 1 47 0 62 -1c61 -8 103 -33 119 -71c6 -15 7 -22 7 -47c0 -24 -1 -35 -5 -49c-5 -19 -17 -34 -32 -42c-10 -6 -13 -9 -16 -16c-4 -9 -1 -20 6 -26c2 -2 7 -5 12 -7c17 -10 30 -22 39 -40c9 -19 13 -41 12 -66c-2 -35 -13 -61 -36 -85 c-31 -30 -77 -47 -134 -49c-55 -1 -103 15 -134 45c-13 14 -20 26 -26 44c-2 7 -2 10 -2 23c0 12 0 14 2 22c7 19 23 35 42 42c7 2 10 2 21 2c10 0 13 0 20 -2c25 -9 43 -32 45 -58c1 -14 -3 -19 -19 -32c-7 -4 -13 -10 -15 -11c-11 -13 -7 -31 9 -41c14 -9 44 -14 60 -10 c28 8 44 38 49 91c1 15 1 61 0 77c-3 35 -13 51 -35 56c-5 2 -15 2 -51 2c-49 0 -49 0 -53 6c-3 4 -4 12 -1 16c3 7 3 7 51 7c23 0 46 0 49 1c11 2 18 5 24 10c8 9 11 17 15 36c2 12 3 64 1 81c-5 48 -26 70 -66 70c-26 0 -47 -8 -54 -20c-3 -5 -3 -6 -3 -13 c0 -6 0 -7 3 -11c1 -3 5 -7 9 -9c15 -11 17 -13 20 -17c2 -4 2 -5 2 -13c0 -23 -14 -43 -38 -52c-9 -3 -26 -4 -35 -1c-19 7 -32 20 -39 39c-1 4 -1 8 -1 18c0 14 1 22 7 34c16 35 58 61 109 67z" id="glyph751" /> <glyph glyph-name="four" unicode="4" horiz-adv-x="400" d="M295 500c9 3 20 -3 20 -11c0 -2 -30 -38 -142 -168c-79 -92 -143 -166 -143 -167h83h83v71c0 70 1 72 3 76c1 3 5 6 17 14c40 27 51 40 69 80c3 7 7 14 8 15c3 3 10 4 14 1c6 -4 6 4 6 -133v-124h38c34 0 38 0 41 -2c5 -2 8 -6 8 -13c0 -6 -3 -10 -8 -12 c-3 -2 -7 -2 -41 -2h-38v-6c-1 -7 1 -22 3 -31c10 -38 34 -62 65 -65c10 0 11 -1 14 -5c4 -6 2 -14 -4 -16c-6 -3 -25 -2 -71 5c-62 8 -70 8 -131 0c-47 -7 -66 -8 -72 -5c-6 2 -8 10 -4 16c3 4 4 5 14 5c21 2 38 13 51 32c11 17 18 41 18 65v5h-87c-85 0 -87 0 -93 2 c-11 3 -18 12 -18 22c0 2 2 5 10 15c50 60 86 123 107 186c14 43 20 72 23 127c1 13 1 14 3 17c5 7 7 7 28 2c29 -7 35 -8 56 -8c13 0 21 0 28 1c10 2 38 9 42 11z" id="glyph753" /> <glyph glyph-name="five" unicode="5" horiz-adv-x="337" d="M37 498c2 1 4 2 5 2s12 -2 25 -3c87 -13 151 -13 240 1c11 1 19 2 21 2c5 -1 10 -6 11 -10s-1 -6 -12 -16c-49 -44 -113 -70 -190 -80c-16 -2 -49 -4 -63 -4c-6 0 -11 -3 -14 -9c-2 -4 -2 -5 -2 -54v-49l8 7c20 17 41 27 68 33c9 2 13 2 34 2c16 0 28 0 37 -1 c88 -12 135 -57 143 -138c3 -32 -2 -61 -16 -87c-7 -15 -15 -25 -28 -38c-28 -28 -63 -45 -106 -53c-17 -3 -52 -3 -70 -1c-60 9 -105 37 -121 75c-5 13 -6 20 -6 35c0 12 0 14 2 22c7 19 23 35 42 42c7 2 10 2 21 2c10 0 13 0 20 -2c25 -9 43 -32 45 -58 c1 -14 -3 -19 -19 -32c-13 -9 -16 -12 -19 -18c-4 -9 -2 -20 5 -27c10 -11 34 -18 62 -18c33 0 52 19 63 60c7 22 10 55 9 88c-2 71 -21 111 -57 120c-5 1 -10 1 -20 1c-26 -1 -48 -6 -66 -16c-12 -6 -20 -13 -30 -24c-5 -7 -8 -9 -11 -10c-7 -2 -15 1 -18 8 c-1 2 -1 23 -1 120v117l2 4c1 2 4 5 6 7z" id="glyph755" /> <glyph glyph-name="six" unicode="6" horiz-adv-x="340" d="M174 499c2 1 9 1 15 1c37 0 74 -11 100 -30c18 -14 30 -30 36 -50c2 -7 2 -10 2 -22s0 -14 -2 -22c-7 -19 -23 -35 -42 -42c-7 -2 -10 -2 -20 -2c-11 0 -14 0 -21 2c-26 9 -44 33 -44 60c0 9 0 10 2 14c2 2 6 6 9 8s9 6 13 9s9 7 10 10c3 4 4 5 4 11s-1 8 -3 12 c-4 6 -8 10 -16 13c-9 5 -19 6 -31 6c-23 -1 -39 -10 -50 -27c-17 -25 -22 -58 -21 -139c1 -24 1 -45 1 -45l10 4c5 2 14 4 20 6c10 2 12 2 29 2c28 0 52 -3 75 -11c41 -14 69 -40 82 -77c6 -17 7 -27 7 -49c0 -23 -1 -33 -6 -50c-7 -19 -15 -32 -29 -47 c-23 -22 -56 -36 -99 -42c-5 -1 -19 -1 -31 -1c-23 0 -31 1 -47 6c-66 21 -112 94 -125 199c-2 18 -2 64 0 80c6 52 22 96 46 132c29 43 68 71 112 79c6 1 12 2 14 2zM185 255c-14 3 -30 1 -41 -5c-16 -8 -23 -26 -26 -58c-1 -17 -1 -88 0 -105c2 -25 7 -40 16 -50 c13 -15 44 -19 65 -7c17 8 26 27 30 60c2 14 2 85 0 99c-4 33 -13 52 -30 60c-4 2 -10 5 -14 6z" id="glyph757" /> <glyph glyph-name="seven" unicode="7" horiz-adv-x="338" d="M8 498c4 3 11 2 15 -1c5 -3 6 -7 6 -19c0 -8 0 -11 2 -14c2 -4 8 -9 10 -9c1 0 4 3 7 7c13 17 31 30 52 35c6 2 10 2 23 2s16 0 24 -2c20 -5 38 -16 56 -32c11 -10 18 -15 27 -18c6 -2 8 -2 20 -2c11 0 14 0 21 2c22 7 42 21 58 41c4 5 8 10 10 11c4 2 11 1 15 -2 c3 -2 6 -8 6 -11c0 -5 -1 -7 -21 -35c-84 -125 -126 -221 -138 -318c-1 -11 -1 -22 -1 -42c0 -30 0 -40 5 -66c2 -14 2 -16 1 -19c-2 -5 -7 -9 -11 -9c-2 0 -11 2 -21 5c-29 9 -38 10 -58 10c-19 0 -26 -1 -56 -10c-11 -3 -20 -5 -21 -5c-6 0 -13 6 -13 12c0 5 21 51 39 85 c38 73 83 142 159 247c10 15 19 27 19 28c1 0 -3 -1 -7 -3c-19 -9 -38 -14 -56 -13c-23 2 -38 9 -59 29c-24 22 -47 32 -63 26c-14 -4 -25 -24 -28 -50c-1 -5 -1 -28 -1 -52c0 -40 0 -45 -2 -48c-2 -5 -6 -7 -12 -7c-7 0 -11 2 -13 7c-2 3 -2 11 -2 118c0 114 1 115 3 118 c1 1 3 3 5 4z" id="glyph759" /> <glyph glyph-name="eight" unicode="8" horiz-adv-x="367" d="M165 499c13 1 48 0 61 -1c42 -7 76 -22 98 -44c23 -23 32 -50 26 -82c-4 -29 -22 -59 -52 -92l-9 -9l8 -5c17 -10 31 -22 42 -36c35 -42 43 -94 20 -140c-23 -47 -70 -77 -138 -88c-16 -2 -56 -2 -72 0c-40 6 -76 21 -103 43c-39 32 -55 83 -41 126c8 21 21 39 50 68 l21 21l-6 4c-16 11 -33 32 -42 50c-22 42 -15 92 16 129c27 31 69 51 121 56zM222 474c-14 3 -37 3 -47 2c-14 -3 -27 -10 -38 -21c-13 -13 -20 -28 -21 -45c-1 -19 5 -34 17 -46c7 -7 13 -10 66 -41c31 -18 58 -33 59 -34c3 -1 24 25 34 42c10 18 16 35 17 54 c2 44 -31 78 -87 89zM170 205c-35 20 -63 36 -64 36c-2 0 -34 -32 -39 -40c-17 -23 -24 -44 -23 -67c2 -27 12 -50 32 -70c20 -19 45 -31 75 -38c11 -2 15 -2 31 -2c15 0 19 0 26 2c15 4 30 13 40 23c32 36 28 91 -9 115c-3 3 -35 21 -69 41z" id="glyph761" /> <glyph glyph-name="nine" unicode="9" horiz-adv-x="340" d="M149 499c10 1 41 0 50 -2c26 -6 49 -18 69 -38c17 -17 28 -33 40 -57c15 -32 24 -66 30 -108c2 -18 2 -64 0 -80c-6 -52 -22 -96 -46 -132s-56 -62 -92 -74c-62 -21 -142 1 -173 47c-5 8 -9 15 -12 25c-2 7 -2 10 -2 22s0 14 2 22c7 19 23 35 42 42c7 2 10 2 21 2 c10 0 13 0 20 -2c26 -9 44 -33 44 -60c0 -9 0 -10 -2 -14c-2 -2 -6 -6 -9 -8s-9 -6 -13 -9s-9 -7 -10 -10c-3 -4 -3 -5 -3 -11s0 -8 2 -12c4 -6 8 -10 16 -13c9 -5 19 -6 31 -6c23 1 39 10 50 27c17 25 22 58 21 139c-1 24 -1 45 -1 45l-10 -4c-5 -2 -14 -4 -20 -6 c-10 -2 -12 -2 -29 -2c-28 0 -52 3 -75 11c-41 14 -69 40 -82 77c-6 17 -7 27 -7 50c0 22 1 32 6 49c7 19 15 32 29 47c26 25 60 38 113 43zM183 476c-14 3 -30 1 -42 -6c-17 -8 -26 -27 -30 -60c-2 -14 -2 -85 0 -99c4 -33 13 -52 30 -60c21 -12 52 -8 65 7 c9 10 14 25 16 50c1 7 1 31 1 52c0 22 0 46 -1 53c-3 39 -14 57 -39 63z" id="glyph763" /> <glyph glyph-name="f" unicode="f" horiz-adv-x="321" d="M332 472c4 0 13 1 21 1c17 -1 29 -4 44 -11c26 -13 40 -34 40 -60c0 -9 -2 -24 -5 -33c-5 -17 -16 -33 -27 -38c-23 -12 -52 -1 -61 23c-3 8 -3 23 0 29c2 4 7 8 15 14c14 8 19 15 20 24c1 11 -3 13 -21 14c-27 1 -42 -7 -55 -27s-21 -43 -34 -101c-2 -12 -4 -22 -5 -23 c0 -1 5 -1 29 -1s30 0 33 -2c10 -4 14 -14 10 -25c-1 -6 -4 -9 -9 -11c-4 -2 -8 -2 -40 -2h-35l-26 -86c-32 -106 -37 -119 -58 -160c-45 -89 -100 -149 -152 -166c-26 -8 -53 -6 -77 6c-27 13 -41 34 -41 60c0 9 2 24 5 34c5 16 16 32 27 37c23 12 52 1 61 -23 c3 -8 3 -23 0 -29c-2 -4 -7 -8 -15 -14c-14 -8 -19 -15 -20 -24c-1 -11 3 -13 21 -14c14 0 21 1 30 5c16 8 28 25 38 56c2 7 22 81 43 165l38 153h-26c-24 0 -27 0 -30 2c-6 2 -9 5 -10 11c-4 11 0 21 10 25c3 2 9 2 35 2h32l2 8c11 30 31 65 53 93c11 13 31 34 44 44 c31 25 63 39 96 44z" id="glyph765" /> <glyph glyph-name="m" unicode="m" horiz-adv-x="438" d="M92 298c4 0 11 1 16 1c7 -1 10 -1 15 -4c11 -5 19 -15 24 -31l2 -8l9 8c24 24 53 37 75 35c18 -2 33 -16 40 -39l1 -6l7 8c26 27 60 42 84 35c28 -7 50 -40 48 -71c-1 -4 -9 -42 -19 -85c-11 -43 -19 -80 -19 -81c0 -4 3 -7 7 -7c8 0 24 10 42 25c12 11 16 13 22 12 c7 -2 10 -9 6 -17c-2 -4 -21 -22 -38 -36c-37 -30 -74 -46 -101 -44c-12 1 -21 7 -26 17c-2 5 -2 7 -2 15c0 9 1 16 20 95c22 92 23 97 19 105c-2 6 -6 8 -14 8c-11 -2 -26 -12 -33 -24c-2 -3 -12 -38 -30 -97c-14 -52 -27 -95 -27 -96c-2 -5 -7 -10 -12 -13l-4 -2l-25 -1 c-28 0 -30 0 -34 6c-1 2 -2 5 -2 7c0 1 12 46 28 98c19 69 27 97 28 103c1 18 -9 24 -28 15c-8 -4 -19 -14 -23 -23c-2 -4 -17 -47 -34 -97s-32 -93 -33 -95c-3 -5 -9 -10 -15 -12c-6 -3 -50 -3 -54 0c-4 1 -7 7 -7 11c0 1 15 45 33 98c35 105 35 105 31 114 c-2 6 -6 8 -14 8c-20 -2 -41 -29 -60 -76c-7 -18 -9 -22 -17 -25c-7 -4 -13 -4 -17 -1c-7 5 -6 11 6 39c30 70 77 118 125 128z" id="glyph767" /> <glyph glyph-name="p" unicode="p" horiz-adv-x="365" d="M67 291c8 2 26 1 36 -2c17 -5 29 -16 37 -32c3 -5 5 -11 6 -13c0 -4 1 -5 4 -1c4 5 19 17 29 24c16 11 30 18 48 22c12 3 37 3 51 0c19 -4 34 -12 47 -24c15 -16 24 -33 29 -57c2 -9 2 -14 2 -30c0 -25 -3 -44 -11 -68c-17 -48 -67 -97 -116 -113c-14 -5 -25 -6 -39 -6 c-22 1 -39 6 -58 15c-7 3 -14 5 -17 6c-5 0 -12 -2 -14 -5c-3 -2 -31 -86 -32 -92c-1 -11 6 -21 17 -27c6 -3 9 -3 27 -6c11 -1 16 -14 8 -23c-4 -5 -6 -5 -22 -4c-36 3 -54 3 -102 3c-49 0 -67 0 -103 -3c-16 -1 -18 -1 -22 4c-6 6 -5 16 2 21c3 2 4 2 28 4c27 2 41 4 49 8 c7 3 13 9 16 13c2 4 103 299 106 311c4 13 2 23 -4 26c-4 2 -13 1 -20 -3c-19 -9 -40 -39 -61 -87c-3 -8 -6 -12 -9 -15c-10 -10 -25 -11 -30 -2c-4 7 -3 11 15 46c33 67 64 101 103 110zM243 241c-6 2 -14 3 -22 0c-36 -10 -69 -64 -85 -136c-7 -31 -6 -53 2 -64 c14 -18 49 -11 69 14c14 18 31 59 42 104c10 41 11 58 4 72c-2 5 -4 7 -10 10z" id="glyph769" /> <glyph glyph-name="r" unicode="r" horiz-adv-x="219" d="M214 306c7 1 30 0 37 -2c22 -6 35 -18 36 -36s-11 -38 -28 -46c-6 -3 -7 -3 -15 -3c-18 0 -26 6 -33 26c-4 11 -6 15 -11 17c-17 8 -53 -12 -64 -34c-2 -5 -11 -40 -29 -107c-14 -56 -27 -104 -28 -106c-3 -6 -7 -10 -13 -13c-4 -2 -7 -2 -28 -2c-25 0 -28 1 -32 5 c-3 6 -4 5 28 126c27 106 29 115 29 123c1 9 -1 13 -6 17s-13 3 -20 0c-14 -7 -31 -29 -37 -49c-4 -11 -18 -17 -27 -10c-5 3 -5 8 -1 19c11 31 27 51 54 64c38 20 85 12 105 -18l4 -6l6 5c22 16 46 26 73 30z" id="glyph771" /> <glyph glyph-name="s" unicode="s" horiz-adv-x="207" d="M147 291c3 0 12 1 20 0c17 0 27 -2 40 -9c22 -10 35 -32 34 -54c-1 -17 -9 -28 -21 -32c-14 -4 -32 3 -38 14c-3 5 -2 9 1 15c11 16 9 34 -4 41c-5 2 -10 3 -20 0c-16 -3 -29 -16 -33 -31c-5 -20 2 -33 27 -47c43 -25 59 -40 68 -63c2 -6 2 -8 2 -20c0 -16 -1 -24 -7 -37 c-9 -22 -29 -42 -52 -54c-20 -10 -37 -13 -59 -13c-19 0 -28 1 -43 9c-20 10 -33 25 -38 45c-6 23 4 49 21 55c18 5 39 -9 41 -28c0 -8 -1 -11 -11 -18c-8 -6 -11 -10 -11 -15c0 -15 23 -25 49 -20c26 6 44 19 49 39c5 21 -6 41 -30 58c-4 3 -14 9 -22 15 c-26 15 -35 23 -42 37l-3 7v13c0 10 0 16 2 22c3 10 10 25 16 33c15 20 39 34 64 38z" id="glyph773" /> <glyph glyph-name="z" unicode="z" horiz-adv-x="286" d="M88 265c7 1 22 1 33 -2c4 -1 15 -5 25 -8c26 -10 32 -11 54 -12c26 -1 33 1 46 11c3 2 6 3 8 3c7 0 13 -5 15 -12c1 -8 5 -5 -91 -95l-88 -83l5 -1c15 0 34 -2 60 -6c59 -8 72 -8 84 3c11 9 15 26 11 40c-2 10 -2 13 0 17c5 7 13 9 20 5c4 -3 7 -10 11 -25s5 -27 5 -40 c-3 -48 -43 -86 -94 -89c-20 -1 -31 3 -63 20c-32 18 -39 20 -69 20c-22 1 -26 0 -32 -4c-7 -6 -11 -7 -15 -7c-5 1 -9 4 -11 8c-3 5 -2 9 1 14c1 2 42 41 90 86l91 87l4 4l-10 -2c-6 0 -21 -2 -33 -2c-40 -3 -44 -4 -80 -11c-16 -3 -26 -3 -31 0c-7 5 -7 20 1 37 c10 20 32 38 53 44z" id="glyph775" /> <hkern u1="2" u2="7" k="-37" id="hkern777" /> <hkern u1="3" u2="0" k="-25" id="hkern779" /> <hkern u1="3" u2="3" k="-25" id="hkern781" /> <hkern u1="f" u2="f" k="38" id="hkern783" /> <hkern u1="m" u2="f" k="29" id="hkern785" /> <hkern u1="m" u2="p" k="-58" id="hkern787" /> <hkern u1="r" u2="f" k="-29" id="hkern789" /> </font> </defs> <g transform="matrix(1.757299,0,0,1.757299,9.9999999,8.786495)" id="g795"> <text style="font-size:2.19953132px;fill:currentColor;font-family:Schoolbook" id="text797"> <tspan id="tspan799" /> </text> </g> <g - id="g9697" - transform="translate(-3.03088,-4.618528)"> + transform="matrix(1.757299,0,0,1.757299,38.772833,21.53798)" + id="g2609"> + <rect + x="0" + y="-3.75" + width="0.19" + height="7.5" + ry="0" + id="rect2611" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,38.772833,31.73031)" + id="g2633"> + <rect + x="0" + y="-2.05" + width="0.19" + height="4.0999999" + ry="0" + id="rect2635" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,6.07375)" + id="g2669"> + <rect + x="35.665848" + y="-0.1" + width="1.974267" + height="0.2" + ry="0.1" + id="rect2671" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,38.772833,11.34565)" + id="g2697"> + <rect + x="0" + y="-2.05" + width="0.19" + height="4.0999999" + ry="0" + id="rect2699" /> + </g> + <g + id="g10210" + transform="matrix(0.7673999,0,0,1,0.2181208,0)"> + <g + id="g2649" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,14.86024)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2651" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2653" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,13.10295)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2655" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2657" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,11.34565)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2659" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2661" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,9.58835)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2663" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2665" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,7.83105)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2667" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2705" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,35.24491)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2707" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> <g - transform="translate(-6,-140)" - id="g8561"> - <g - transform="matrix(1.757299,0,0,1.757299,77.12448,176.34884)" - id="g2601"> - <rect - x="0" - y="-2.05" - width="0.19" - height="4.0999999" - ry="0" - id="rect2603" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,47.803713,166.15651)" - id="g2609"> - <rect - x="0" - y="-3.75" - width="0.19" - height="7.5" - ry="0" - id="rect2611" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,47.803713,176.34884)" - id="g2633"> - <rect - x="0" - y="-2.05" - width="0.19" - height="4.0999999" - ry="0" - id="rect2635" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,77.12448,166.15651)" - id="g2641"> - <rect - x="0" - y="-3.75" - width="0.19" - height="7.5" - ry="0" - id="rect2643" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,77.12448,155.96418)" - id="g2645"> - <rect - x="0" - y="-2.05" - width="0.19" - height="4.0999999" - ry="0" - id="rect2647" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,159.47877)" - id="g2649"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2651" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,157.72148)" - id="g2653"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2655" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,155.96418)" - id="g2657"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2659" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,154.20688)" - id="g2661"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2663" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,152.44958)" - id="g2665"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2667" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,150.69228)" - id="g2669"> - <rect - x="35.665848" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2671" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,47.803713,155.96418)" - id="g2697"> - <rect - x="0" - y="-2.05" - width="0.19" - height="4.0999999" - ry="0" - id="rect2699" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,179.86344)" - id="g2705"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2707" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,178.10614)" - id="g2709"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2711" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,176.34884)" - id="g2713"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2715" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,174.59155)" - id="g2717"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2719" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(0.6225997,0,0,1.757299,9.9999999,172.83425)" - id="g2721"> - <line - x1="0.050000001" - y1="0" - x2="108.07047" - y2="0" - id="line2723" - style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,171.07695)" - id="g2749"> - <rect - x="27.938734" - y="-0.1" - width="2.084976" - height="0.2" - ry="0.1" - id="rect2751" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,169.31965)" - id="g2753"> - <rect - x="27.938734" - y="-0.1" - width="2.084976" - height="0.2" - ry="0.1" - id="rect2755" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,171.07695)" - id="g2757"> - <rect - x="35.665848" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2759" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,169.31965)" - id="g2761"> - <rect - x="35.665848" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2763" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,171.07695)" - id="g2765"> - <rect - x="35.665848" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2767" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,171.07695)" - id="g2769"> - <rect - x="42.711384" - y="-0.1" - width="2.084976" - height="0.2" - ry="0.1" - id="rect2771" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,169.31965)" - id="g2773"> - <rect - x="42.711384" - y="-0.1" - width="2.084976" - height="0.2" - ry="0.1" - id="rect2775" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,171.07695)" - id="g2777"> - <rect - x="42.729836" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2779" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-24,171.07695)" - id="g2781"> - <rect - x="47.595215" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2783" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-30,171.07695)" - id="g2785"> - <rect - x="55.765308" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2787" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,-30,169.31965)" - id="g2789"> - <rect - x="55.765308" - y="-0.1" - width="1.974267" - height="0.2" - ry="0.1" - id="rect2791" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,9.894562,166.15651)" - id="g3017"> - <rect - x="0" - y="-7.8499999" - width="0.16" - height="15.7" - ry="0.050000001" - id="rect3019" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,17.556386,174.59155)" - id="g3021"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3023"> - <tspan - id="tspan3025"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,19.489425,177.22749)" - id="g3027"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3029"> - <tspan - id="tspan3031"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,11.405839,174.59155)" - id="g3033"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3035"> - <tspan - id="tspan3037"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,17.556386,152.44958)" - id="g3039"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3041"> - <tspan - id="tspan3043"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,19.489425,155.08553)" - id="g3045"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3047"> - <tspan - id="tspan3049"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,11.405839,157.72148)" - id="g3051"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3053"> - <tspan - id="tspan3055"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,25.821589,176.34884)" - id="g3249"> - <rect - x="-0.064999998" - y="1.261386" - width="0.13" - height="2.2386141" - ry="0.039999999" - id="rect3251" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,28.035758,176.34884)" - id="g3253"> - <rect - x="-0.064999998" - y="-7" - width="0.13" - height="2.2386141" - ry="0.039999999" - id="rect3255" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,25.821589,155.96418)" - id="g3257"> - <rect - x="-0.064999998" - y="0.26138601" - width="0.13" - height="2.7386141" - ry="0.039999999" - id="rect3259" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,28.035758,155.96418)" - id="g3261"> - <rect - x="-0.064999998" - y="-3.5" - width="0.13" - height="2.2386141" - ry="0.039999999" - id="rect3263" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,25.707365,178.10614)" - id="g3277"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3279"> - <tspan - id="tspan3281"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,25.707365,168.441)" - id="g3283"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3285"> - <tspan - id="tspan3287"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,25.707365,155.96418)" - id="g3289"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3291"> - <tspan - id="tspan3293"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,25.707365,154.20688)" - id="g3295"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3297"> - <tspan - id="tspan3299"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,39.36801,176.34884)" - id="g3337"> - <rect - x="-0.064999998" - y="-2.812186" - width="0.13" - height="3.312186" - ry="0.039999999" - id="rect3339" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,41.452479,176.34884)" - id="g3341"> - <rect - x="-0.064999998" - y="-6.5" - width="0.13" - height="2.312186" - ry="0.039999999" - id="rect3343" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,60.331478,176.34884)" - id="g3405"> - <rect - x="-0.064999998" - y="-2.812186" - width="0.13" - height="3.312186" - ry="0.039999999" - id="rect3407" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,60.217254,171.07695)" - id="g3421"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3423"> - <tspan - id="tspan3425"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,51.781553,176.34884)" - id="g3427"> - <rect - x="-0.064999998" - y="-3.312186" - width="0.13" - height="3.312186" - ry="0.039999999" - id="rect3429" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,53.995721,176.34884)" - id="g3431"> - <rect - x="-0.064999998" - y="-7" - width="0.13" - height="2.2386141" - ry="0.039999999" - id="rect3433" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,68.68878,176.34884)" - id="g3447"> - <rect - x="-0.064999998" - y="-2.312186" - width="0.13" - height="3.312186" - ry="0.039999999" - id="rect3449" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,70.77325,176.34884)" - id="g3451"> - <rect - x="-0.064999998" - y="-7" - width="0.13" - height="2.312186" - ry="0.039999999" - id="rect3453" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,68.68878,155.96418)" - id="g3455"> - <rect - x="-0.064999998" - y="0.187814" - width="0.13" - height="2.812186" - ry="0.039999999" - id="rect3457" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,70.77325,155.96418)" - id="g3459"> - <rect - x="-0.064999998" - y="-3.5" - width="0.13" - height="2.312186" - ry="0.039999999" - id="rect3461" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,68.57455,171.9556)" - id="g3475"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3477"> - <tspan - id="tspan3479"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,68.57455,168.441)" - id="g3481"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3483"> - <tspan - id="tspan3485"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,68.57455,155.96418)" - id="g3487"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3489"> - <tspan - id="tspan3491"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,68.57455,154.20688)" - id="g3493"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3495"> - <tspan - id="tspan3497"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,39.36801,155.96418)" - id="g3499"> - <rect - x="-0.064999998" - y="0.687814" - width="0.13" - height="2.812186" - ry="0.039999999" - id="rect3501" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,41.452479,155.96418)" - id="g3503"> - <rect - x="-0.064999998" - y="-5.5" - width="0.13" - height="2.312186" - ry="0.039999999" - id="rect3505" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,39.253786,171.07695)" - id="g3519"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3521"> - <tspan - id="tspan3523"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,39.253786,169.31965)" - id="g3525"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3527"> - <tspan - id="tspan3529"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,39.253786,156.84283)" - id="g3531"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3533"> - <tspan - id="tspan3535"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,39.253786,150.69228)" - id="g3537"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3539"> - <tspan - id="tspan3541"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,51.781553,155.96418)" - id="g3543"> - <rect - x="-0.064999998" - y="0.76138598" - width="0.13" - height="2.7386141" - ry="0.039999999" - id="rect3545" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,53.995721,155.96418)" - id="g3547"> - <rect - x="-0.064999998" - y="-4.5" - width="0.13" - height="2.2386141" - ry="0.039999999" - id="rect3549" /> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,51.667328,170.1983)" - id="g3563"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3565"> - <tspan - id="tspan3567"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,51.667328,168.441)" - id="g3569"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3571"> - <tspan - id="tspan3573"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,51.667328,156.84283)" - id="g3575"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3577"> - <tspan - id="tspan3579"></tspan> - </text> - </g> - <g - transform="matrix(1.757299,0,0,1.757299,51.667328,152.44958)" - id="g3581"> - <text - style="font-size:4px;fill:currentColor;font-family:Emmentaler" - id="text3583"> - <tspan - id="tspan3585"></tspan> - </text> - </g> - <text - xml:space="preserve" - style="font-size:2.7042923px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="10.06612" - y="136.25922" - id="text8557" - transform="scale(0.9046596,1.1053881)"><tspan - sodipodi:role="line" - id="tspan8559" - x="10.06612" - y="136.25922">12</tspan></text> + id="g2709" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,33.48761)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2711" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> </g> - <path - d="M 38.415242 9.5781898 A 3.790498 4.5194402 0 1 1 30.834246,9.5781898 A 3.790498 4.5194402 0 1 1 38.415242 9.5781898 z" - sodipodi:ry="4.5194402" - sodipodi:rx="3.790498" - sodipodi:cy="9.5781898" - sodipodi:cx="34.624744" - id="path8726" - style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.53149605;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" - sodipodi:type="arc" /> + <g + id="g2713" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,31.73031)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2715" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2717" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,29.97302)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2719" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + <g + id="g2721" + transform="matrix(0.6225997,0,0,1.757299,0.9691199,28.21572)"> + <line + style="stroke:currentColor;stroke-width:0.1;stroke-linecap:round;stroke-linejoin:round" + id="line2723" + y2="0" + x2="108.07047" + y1="0" + x1="0.050000001" /> + </g> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,26.45842)" + id="g2749"> + <rect + x="27.938734" + y="-0.1" + width="2.084976" + height="0.2" + ry="0.1" + id="rect2751" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,24.70112)" + id="g2753"> + <rect + x="27.938734" + y="-0.1" + width="2.084976" + height="0.2" + ry="0.1" + id="rect2755" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,26.45842)" + id="g2757"> + <rect + x="35.665848" + y="-0.1" + width="1.974267" + height="0.2" + ry="0.1" + id="rect2759" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,24.70112)" + id="g2761"> + <rect + x="35.665848" + y="-0.1" + width="1.974267" + height="0.2" + ry="0.1" + id="rect2763" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,26.45842)" + id="g2765"> + <rect + x="35.665848" + y="-0.1" + width="1.974267" + height="0.2" + ry="0.1" + id="rect2767" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,26.45842)" + id="g2769"> + <rect + x="42.711384" + y="-0.1" + width="2.084976" + height="0.2" + ry="0.1" + id="rect2771" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,24.70112)" + id="g2773"> + <rect + x="42.711384" + y="-0.1" + width="2.084976" + height="0.2" + ry="0.1" + id="rect2775" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,-33.03088,26.45842)" + id="g2777"> + <rect + x="42.729836" + y="-0.1" + width="1.974267" + height="0.2" + ry="0.1" + id="rect2779" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,0.863682,21.53798)" + id="g3017"> + <rect + x="0" + y="-7.8499999" + width="0.16" + height="15.7" + ry="0.050000001" + id="rect3019" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,8.525506,29.97302)" + id="g3021"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3023"> + <tspan + id="tspan3025"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,10.458545,32.60896)" + id="g3027"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3029"> + <tspan + id="tspan3031"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,2.374959,29.97302)" + id="g3033"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3035"> + <tspan + id="tspan3037"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,8.525506,7.83105)" + id="g3039"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3041"> + <tspan + id="tspan3043"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,10.458545,10.467)" + id="g3045"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3047"> + <tspan + id="tspan3049"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,2.374959,13.10295)" + id="g3051"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3053"> + <tspan + id="tspan3055"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,16.790709,31.73031)" + id="g3249"> + <rect + x="-0.064999998" + y="1.261386" + width="0.13" + height="2.2386141" + ry="0.039999999" + id="rect3251" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,19.004878,31.73031)" + id="g3253"> + <rect + x="-0.064999998" + y="-7" + width="0.13" + height="2.2386141" + ry="0.039999999" + id="rect3255" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,16.790709,11.34565)" + id="g3257"> + <rect + x="-0.064999998" + y="0.26138601" + width="0.13" + height="2.7386141" + ry="0.039999999" + id="rect3259" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,19.004878,11.34565)" + id="g3261"> + <rect + x="-0.064999998" + y="-3.5" + width="0.13" + height="2.2386141" + ry="0.039999999" + id="rect3263" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,16.676485,33.48761)" + id="g3277"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3279"> + <tspan + id="tspan3281"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,16.676485,23.82247)" + id="g3283"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3285"> + <tspan + id="tspan3287"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,16.676485,11.34565)" + id="g3289"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3291"> + <tspan + id="tspan3293"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,16.676485,9.58835)" + id="g3295"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3297"> + <tspan + id="tspan3299"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,30.33713,31.73031)" + id="g3337"> + <rect + x="-0.064999998" + y="-2.812186" + width="0.13" + height="3.312186" + ry="0.039999999" + id="rect3339" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,32.421599,31.73031)" + id="g3341"> + <rect + x="-0.064999998" + y="-6.5" + width="0.13" + height="2.312186" + ry="0.039999999" + id="rect3343" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,42.750673,31.73031)" + id="g3427"> + <rect + x="-0.064999998" + y="-3.312186" + width="0.13" + height="3.312186" + ry="0.039999999" + id="rect3429" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,44.964841,31.73031)" + id="g3431"> + <rect + x="-0.064999998" + y="-7" + width="0.13" + height="2.2386141" + ry="0.039999999" + id="rect3433" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,30.33713,11.34565)" + id="g3499"> + <rect + x="-0.064999998" + y="0.687814" + width="0.13" + height="2.812186" + ry="0.039999999" + id="rect3501" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,32.421599,11.34565)" + id="g3503"> + <rect + x="-0.064999998" + y="-5.5" + width="0.13" + height="2.312186" + ry="0.039999999" + id="rect3505" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,30.222906,26.45842)" + id="g3519"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3521"> + <tspan + id="tspan3523"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,30.222906,24.70112)" + id="g3525"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3527"> + <tspan + id="tspan3529"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,30.222906,12.2243)" + id="g3531"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3533"> + <tspan + id="tspan3535"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,30.222906,6.07375)" + id="g3537"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3539"> + <tspan + id="tspan3541"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,42.750673,11.34565)" + id="g3543"> + <rect + x="-0.064999998" + y="0.76138598" + width="0.13" + height="2.7386141" + ry="0.039999999" + id="rect3545" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,44.964841,11.34565)" + id="g3547"> + <rect + x="-0.064999998" + y="-4.5" + width="0.13" + height="2.2386141" + ry="0.039999999" + id="rect3549" /> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,42.636448,25.57977)" + id="g3563"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3565"> + <tspan + id="tspan3567"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,42.636448,23.82247)" + id="g3569"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3571"> + <tspan + id="tspan3573"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,42.636448,12.2243)" + id="g3575"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3577"> + <tspan + id="tspan3579"></tspan> + </text> + </g> + <g + transform="matrix(1.757299,0,0,1.757299,42.636448,7.83105)" + id="g3581"> + <text + style="font-size:4px;fill:currentColor;font-family:Emmentaler" + id="text3583"> + <tspan + id="tspan3585"></tspan> + </text> </g> + <text + xml:space="preserve" + style="font-size:2.7042923px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" + x="0.083492428" + y="5.428669" + id="text8557" + transform="scale(0.9046596,1.1053881)"><tspan + sodipodi:role="line" + id="tspan8559" + x="0.083492428" + y="5.428669">12</tspan></text> + <path + sodipodi:type="arc" + style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.53149605;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + id="path8726" + sodipodi:cx="34.624744" + sodipodi:cy="9.5781898" + sodipodi:rx="3.790498" + sodipodi:ry="4.5194402" + d="M 38.415242 9.5781898 A 3.790498 4.5194402 0 1 1 30.834246,9.5781898 A 3.790498 4.5194402 0 1 1 38.415242 9.5781898 z" + transform="translate(-3.03088,-4.618528)" /> </svg>
mdsmus/musicologia-computacional
69ed331955433f728e0705241c71af6bd782d918
Insere figura de soprano agudo no texto
diff --git a/body-pt.tex b/body-pt.tex index db1394a..d381cc7 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,304 +1,316 @@ \section{Introdução} \label{sec:introducao} \note{introduz o assunto} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais ficaram de fora por problemas na conversão de MIDI para Lilypond (ver seção \ref{sec:metodologia}). \note{Reescrever para tirar duplicidade de Kostka e Payne} Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos musicais usuais em classes de harmonia. Neste trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o sistema \rameau{}\footnote{Está descrito em outro trabalho do autor, a citação foi removida por anonimato e será acrescentada na ocasião da publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa cada conjunto de notas a um acorde. \note{Qual trabalho? o do artigo ou o análise automática?} Para este trabalho, o \rameau{} foi extendido para realizar operações comuns de musicologia, como detecção de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, etc. Além disso \rameau{} possui vários outros algoritmos para análise harmônica, como o de \note{Reescrever para tirar duplicidade de Pardo e Birmingham} Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para o Lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos profissionais e não pela congregação \cite{bach41:371} \note{não gosto de ``escritos para serem cantados''}. Isso \note{nao começa com isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos por KP e os utilizados por Bach nos corais analizados. Bach amplia o âmbito de soprano e tenor em uma segunda maior ascendente \note{há uma forma melhor de dizer isso sem usar ascendente e descendente?}, e o do contralto em uma segunda maior descendente. A voz do baixo tem ampliação de uma terça maior em ambas direções (comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais onde as notas mais agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} +\begin{figure} + \centering + \subfigure[Soprano agudo]{ + \includegraphics[scale=3]{334-soprano-agudo} + } + \subfigure[Soprano agudo]{ + \includegraphics[scale=3]{334-soprano-agudo} + } + \caption{Âmbitos} + \label{fig:ambitos-alem} +\end{figure} + \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo estão acima da voz do contralto) (vide figura \ref{fig:035-cruzamento}), e no coral 290 existe um cruzamento simultâneo de baixo com o tenor e do contralto com o soprano (vide figura \ref{fig:290-66-74-cruzamento}). \begin{figure} \centering \subfigure[Coral 35]{ \includegraphics[scale=3]{035-cruzamento} \label{fig:035-cruzamento} } \subfigure[Coral 290]{ \includegraphics[scale=3]{290-66-74-cruzamento} \label{fig:290-66-74-cruzamento} } \subfigure[Coral 3]{ \includegraphics[scale=3]{003-38-42-cruzamento} \label{fig:003-38-42-cruzamento} } \caption{Cruzamentos entre vozes} \label{fig:coral-003} \end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar quintas e oitavas consecutivas \note{Escolher as figuras para este trecho} \note{fig} e para manter melhor condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma frase e primeiro acorde da próxima. \note{Não começar com isso} Isso ocorre nos corais 45 e 46 (quintas) e 2, 89, e 279 (oitavas) (vide figura \ref{fig:279-oitava}) \note{melhorar referência a figura}. Uma possível justificativa é a ``quebra'' de uma frase para outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no total) ocorrem no meio de frases. Todas as oitavas nessa categoria são uníssono--oitava ou oitava--uníssono (vide figura \ref{fig:oitavas-e-unissonos}). \note{``para o alívio'' é muito informal} Para o alívio dos professores de harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, 266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} \label{fig:244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} \label{fig:279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} \label{fig:329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de sexta aumentada francesa (vide figura \ref{fig:sextas-aumentadas}). \begin{figure} \centering \subfigure[Sexta alemã]{ \includegraphics[scale=3]{340-52-55-alema} } \subfigure[Sexta italiana]{ \includegraphics[scale=3]{019-4-6-italiana} } \subfigure[Sexta francesa]{ \includegraphics[scale=3]{146-21-27-francesa} } \caption{Sextas aumentadas} \label{fig:sextas-aumentadas} \end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. Verificamos o tratamento destas sétimas em \note{O termo segmento será utilizado neste artigo?} segmentos adjacentes. Em 77\% dos casos as sétimas são resolvidas descendentemente e por grau conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde de bm7 se transforma na tônica do acorde seguinte, de A. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos corais \note{não entendi a relação entre ingenuidade e erros}. Por exemplo, a cadência final do coral 362 é I$^6_4$ V$_7$ I, mas o algoritmo interpreta a antecipação para a terça do acorde final como um acorde menor do terceiro grau (iii). Além disso, como o algoritmo sempre considera que o acorde final é de tônica, ele classifica eroneamente os corais que terminam em acordes diferentes da tônica, como os que terminam em meia-cadência. \begin{figure} \centering \includegraphics[scale=3]{341-99-104-cadencia} \caption{Cadência} \label{fig:cadencia} \end{figure} \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex %%% TeX-master: "musicologia-computacional-anppom" %%% End:
mdsmus/musicologia-computacional
8a727ea9fd1ae355f44af6e2c609ef9a74e62bc0
Insere sexta francesa no texto
diff --git a/body-pt.tex b/body-pt.tex index 9b49b08..db1394a 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,301 +1,304 @@ \section{Introdução} \label{sec:introducao} \note{introduz o assunto} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais ficaram de fora por problemas na conversão de MIDI para Lilypond (ver seção \ref{sec:metodologia}). \note{Reescrever para tirar duplicidade de Kostka e Payne} Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos musicais usuais em classes de harmonia. Neste trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o sistema \rameau{}\footnote{Está descrito em outro trabalho do autor, a citação foi removida por anonimato e será acrescentada na ocasião da publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa cada conjunto de notas a um acorde. \note{Qual trabalho? o do artigo ou o análise automática?} Para este trabalho, o \rameau{} foi extendido para realizar operações comuns de musicologia, como detecção de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, etc. Além disso \rameau{} possui vários outros algoritmos para análise harmônica, como o de \note{Reescrever para tirar duplicidade de Pardo e Birmingham} Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para o Lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos profissionais e não pela congregação \cite{bach41:371} \note{não gosto de ``escritos para serem cantados''}. Isso \note{nao começa com isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos por KP e os utilizados por Bach nos corais analizados. Bach amplia o âmbito de soprano e tenor em uma segunda maior ascendente \note{há uma forma melhor de dizer isso sem usar ascendente e descendente?}, e o do contralto em uma segunda maior descendente. A voz do baixo tem ampliação de uma terça maior em ambas direções (comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais onde as notas mais agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo estão acima da voz do contralto) (vide figura \ref{fig:035-cruzamento}), e no coral 290 existe um cruzamento simultâneo de baixo com o tenor e do contralto com o soprano (vide figura \ref{fig:290-66-74-cruzamento}). \begin{figure} \centering \subfigure[Coral 35]{ \includegraphics[scale=3]{035-cruzamento} \label{fig:035-cruzamento} } \subfigure[Coral 290]{ \includegraphics[scale=3]{290-66-74-cruzamento} \label{fig:290-66-74-cruzamento} } \subfigure[Coral 3]{ \includegraphics[scale=3]{003-38-42-cruzamento} \label{fig:003-38-42-cruzamento} } \caption{Cruzamentos entre vozes} \label{fig:coral-003} \end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar quintas e oitavas consecutivas \note{Escolher as figuras para este trecho} \note{fig} e para manter melhor condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma frase e primeiro acorde da próxima. \note{Não começar com isso} Isso ocorre nos corais 45 e 46 (quintas) e 2, 89, e 279 (oitavas) (vide figura \ref{fig:279-oitava}) \note{melhorar referência a figura}. Uma possível justificativa é a ``quebra'' de uma frase para outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no total) ocorrem no meio de frases. Todas as oitavas nessa categoria são uníssono--oitava ou oitava--uníssono (vide figura \ref{fig:oitavas-e-unissonos}). \note{``para o alívio'' é muito informal} Para o alívio dos professores de harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, 266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} \label{fig:244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} \label{fig:279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} \label{fig:329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de sexta aumentada francesa (vide figura \ref{fig:sextas-aumentadas}). \begin{figure} \centering \subfigure[Sexta alemã]{ \includegraphics[scale=3]{340-52-55-alema} } \subfigure[Sexta italiana]{ \includegraphics[scale=3]{019-4-6-italiana} } + \subfigure[Sexta francesa]{ + \includegraphics[scale=3]{146-21-27-francesa} + } \caption{Sextas aumentadas} \label{fig:sextas-aumentadas} \end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. Verificamos o tratamento destas sétimas em \note{O termo segmento será utilizado neste artigo?} segmentos adjacentes. Em 77\% dos casos as sétimas são resolvidas descendentemente e por grau conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde de bm7 se transforma na tônica do acorde seguinte, de A. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos corais \note{não entendi a relação entre ingenuidade e erros}. Por exemplo, a cadência final do coral 362 é I$^6_4$ V$_7$ I, mas o algoritmo interpreta a antecipação para a terça do acorde final como um acorde menor do terceiro grau (iii). Além disso, como o algoritmo sempre considera que o acorde final é de tônica, ele classifica eroneamente os corais que terminam em acordes diferentes da tônica, como os que terminam em meia-cadência. \begin{figure} \centering \includegraphics[scale=3]{341-99-104-cadencia} \caption{Cadência} \label{fig:cadencia} \end{figure} \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex %%% TeX-master: "musicologia-computacional-anppom" %%% End:
mdsmus/musicologia-computacional
7b34aeaca355169bb82e004306cf94cf2a7e07f2
Notas e correções
diff --git a/body-pt.tex b/body-pt.tex index 88f3d49..9b49b08 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,292 +1,301 @@ \section{Introdução} \label{sec:introducao} \note{introduz o assunto} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais -ficaram de fora por problemas na conversão de MIDI para lilypond (ver -seção \ref{sec:metodologia}). Kostka e Payne \cite{kostka.ea00:tonal} +ficaram de fora por problemas na conversão de MIDI para Lilypond (ver +seção \ref{sec:metodologia}). \note{Reescrever para tirar duplicidade + de Kostka e Payne} Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos -musicais usuais em classes de harmonia. Nesse trabalho o livro é +musicais usuais em classes de harmonia. Neste trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o sistema \rameau{}\footnote{Está descrito em outro trabalho do autor, a citação foi removida por anonimato e será acrescentada na ocasião da publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa -cada conjunto de notas a um acorde. Para este trabalho, o \rameau{} -foi extendido para realizar operações comuns de musicologia, como -detecção de cruzamentos, quintas ou oitavas consecutivas, cadências -frequentes, etc. +cada conjunto de notas a um acorde. \note{Qual trabalho? o do artigo + ou o análise automática?} Para este trabalho, o \rameau{} foi +extendido para realizar operações comuns de musicologia, como detecção +de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, +etc. Além disso \rameau{} possui vários outros algoritmos para análise -harmônica, como o de Pardo e Birmingham \cite{pardo.ea00:automated}, +harmônica, como o de \note{Reescrever para tirar duplicidade + de Pardo e Birmingham} Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para -o lilypond por uma ferramenta automática e depois corrigidos +o Lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos -profissionais e não pela congregação \cite{bach41:371}. Isso \note{nao - começa com isso} se reflete na textura, cruzamentos e no âmbito -vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os -âmbitos sugeridos por KP e os utilizados por Bach nos corais -analizados. Bach amplia o âmbito de soprano e tenor em uma segunda -maior ascendente, e o do contralto em uma segunda maior descendente. A -voz do baixo tem ampliação de uma terça maior em ambas direções -(comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais -onde as notas mais agudas e graves ocorrem em cada voz. +profissionais e não pela congregação \cite{bach41:371} \note{não gosto + de ``escritos para serem cantados''}. Isso \note{nao começa com + isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos +corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos +por KP e os utilizados por Bach nos corais analizados. Bach amplia o +âmbito de soprano e tenor em uma segunda maior ascendente \note{há uma + forma melhor de dizer isso sem usar ascendente e descendente?}, e o +do contralto em uma segunda maior descendente. A voz do baixo tem +ampliação de uma terça maior em ambas direções (comparando com KP). A +tabela \ref{tab:notas-extremas} lista os corais onde as notas mais +agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo -estão acima da voz do contralto) \ref{fig:035-cruzamento}, e no coral -290 existe um cruzamento simultâneo de baixo com o tenor e do -contralto com o soprano \ref{fig:290-66-74-cruzamento}. +estão acima da voz do contralto) (vide figura +\ref{fig:035-cruzamento}), e no coral 290 existe um cruzamento +simultâneo de baixo com o tenor e do contralto com o soprano (vide +figura \ref{fig:290-66-74-cruzamento}). \begin{figure} \centering \subfigure[Coral 35]{ \includegraphics[scale=3]{035-cruzamento} \label{fig:035-cruzamento} } \subfigure[Coral 290]{ \includegraphics[scale=3]{290-66-74-cruzamento} \label{fig:290-66-74-cruzamento} } \subfigure[Coral 3]{ \includegraphics[scale=3]{003-38-42-cruzamento} \label{fig:003-38-42-cruzamento} } \caption{Cruzamentos entre vozes} \label{fig:coral-003} \end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar -quintas e oitavas consecutivas \note{fig} e para manter melhor -condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam -ser evitados. +quintas e oitavas consecutivas \note{Escolher as figuras para este + trecho} \note{fig} e para manter melhor condução de vozes +\note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma -frase e primeiro acorde da próxima. Isso ocorre nos corais 45 e 46 -(quintas) e 2, 89, e 279 (oitavas). (vide figura \ref{fig:279-oitava}) -Uma possível justificativa é a ``quebra'' de uma frase para +frase e primeiro acorde da próxima. \note{Não começar com isso} Isso +ocorre nos corais 45 e 46 (quintas) e 2, 89, e 279 (oitavas) (vide +figura \ref{fig:279-oitava}) \note{melhorar referência a figura}. Uma +possível justificativa é a ``quebra'' de uma frase para outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no total) ocorrem no meio de frases. Todas as oitavas nessa categoria são uníssono--oitava ou oitava--uníssono (vide figura -\ref{fig:oitavas-e-unissonos}). Para o alívio dos professores de -harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas -são: nos corais 4, 46, 71, 266. +\ref{fig:oitavas-e-unissonos}). \note{``para o alívio'' é muito + informal} Para o alívio dos professores de harmonia, nenhuma dessas +oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, +266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} \label{fig:244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} \label{fig:279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} \label{fig:329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de sexta aumentada francesa (vide figura \ref{fig:sextas-aumentadas}). \begin{figure} \centering \subfigure[Sexta alemã]{ \includegraphics[scale=3]{340-52-55-alema} } \subfigure[Sexta italiana]{ \includegraphics[scale=3]{019-4-6-italiana} } \caption{Sextas aumentadas} \label{fig:sextas-aumentadas} \end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. -Verificamos o tratamento destas sétimas em segmentos adjacentes. Em -77\% dos casos as sétimas são resolvidas descendentemente e por grau -conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. -Nos acordes restantes em geral ocorre uma das quatro situações -seguintes: +Verificamos o tratamento destas sétimas em \note{O termo segmento será + utilizado neste artigo?} segmentos adjacentes. Em 77\% dos casos as +sétimas são resolvidas descendentemente e por grau conjunto, ou seja, +da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes +restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde - de bm7 se transforma na tônica do acorde seguinte, de $A$. + de bm7 se transforma na tônica do acorde seguinte, de A. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos -corais. Por exemplo, a cadência final do coral 362 é I$^6_4$ V7 I, mas -o algoritmo interpreta a antecipação para a terça do acorde final como -um acorde menor do terceiro grau (iii). Além disso, como o algoritmo -sempre considera que o acorde final é de tônica, ele classifica -eroneamente os corais que terminam em acordes diferentes da tônica, -como os que terminam em meia-cadência. +corais \note{não entendi a relação entre ingenuidade e erros}. Por +exemplo, a cadência final do coral 362 é I$^6_4$ V$_7$ I, mas o algoritmo +interpreta a antecipação para a terça do acorde final como um acorde +menor do terceiro grau (iii). Além disso, como o algoritmo sempre +considera que o acorde final é de tônica, ele classifica eroneamente +os corais que terminam em acordes diferentes da tônica, como os que +terminam em meia-cadência. \begin{figure} \centering \includegraphics[scale=3]{341-99-104-cadencia} \caption{Cadência} \label{fig:cadencia} \end{figure} \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex %%% TeX-master: "musicologia-computacional-anppom" %%% End:
mdsmus/musicologia-computacional
d8076f83e50e2ec1a95d4c09dc4221362572a8ab
Corrige pequenos erros
diff --git a/body-pt.tex b/body-pt.tex index 4493f31..88f3d49 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,292 +1,292 @@ \section{Introdução} \label{sec:introducao} \note{introduz o assunto} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais ficaram de fora por problemas na conversão de MIDI para lilypond (ver seção \ref{sec:metodologia}). Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos musicais usuais em classes de harmonia. Nesse trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o -sistema \rameau{}\footnote{Èstá descrito em outro trabalho do autor, - a citação foi removida por anonimato e será acrescentada na ocasião - da publicação.} para análise automática de harmonia e extração de +sistema \rameau{}\footnote{Está descrito em outro trabalho do autor, a + citação foi removida por anonimato e será acrescentada na ocasião da + publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa cada conjunto de notas a um acorde. Para este trabalho, o \rameau{} foi extendido para realizar operações comuns de musicologia, como detecção de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, etc. Além disso \rameau{} possui vários outros algoritmos para análise harmônica, como o de Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para o lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos profissionais e não pela congregação \cite{bach41:371}. Isso \note{nao começa com isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos por KP e os utilizados por Bach nos corais analizados. Bach amplia o âmbito de soprano e tenor em uma segunda maior ascendente, e o do contralto em uma segunda maior descendente. A voz do baixo tem ampliação de uma terça maior em ambas direções (comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais onde as notas mais agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo estão acima da voz do contralto) \ref{fig:035-cruzamento}, e no coral 290 existe um cruzamento simultâneo de baixo com o tenor e do contralto com o soprano \ref{fig:290-66-74-cruzamento}. \begin{figure} \centering \subfigure[Coral 35]{ \includegraphics[scale=3]{035-cruzamento} \label{fig:035-cruzamento} } \subfigure[Coral 290]{ \includegraphics[scale=3]{290-66-74-cruzamento} \label{fig:290-66-74-cruzamento} } \subfigure[Coral 3]{ \includegraphics[scale=3]{003-38-42-cruzamento} \label{fig:003-38-42-cruzamento} } \caption{Cruzamentos entre vozes} \label{fig:coral-003} \end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar quintas e oitavas consecutivas \note{fig} e para manter melhor condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma frase e primeiro acorde da próxima. Isso ocorre nos corais 45 e 46 (quintas) e 2, 89, e 279 (oitavas). (vide figura \ref{fig:279-oitava}) Uma possível justificativa é a ``quebra'' de uma frase para outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no total) ocorrem no meio de frases. Todas as oitavas nessa categoria são uníssono--oitava ou oitava--uníssono (vide figura \ref{fig:oitavas-e-unissonos}). Para o alívio dos professores de harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, 266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} \label{fig:244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} \label{fig:279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} \label{fig:329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de -sexta aumentada francesa (vide figura\ref{fig:sextas-aumentadas}). +sexta aumentada francesa (vide figura \ref{fig:sextas-aumentadas}). \begin{figure} \centering \subfigure[Sexta alemã]{ \includegraphics[scale=3]{340-52-55-alema} } \subfigure[Sexta italiana]{ \includegraphics[scale=3]{019-4-6-italiana} } \caption{Sextas aumentadas} \label{fig:sextas-aumentadas} \end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. Verificamos o tratamento destas sétimas em segmentos adjacentes. Em 77\% dos casos as sétimas são resolvidas descendentemente e por grau conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde de bm7 se transforma na tônica do acorde seguinte, de $A$. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos corais. Por exemplo, a cadência final do coral 362 é I$^6_4$ V7 I, mas o algoritmo interpreta a antecipação para a terça do acorde final como um acorde menor do terceiro grau (iii). Além disso, como o algoritmo sempre considera que o acorde final é de tônica, ele classifica eroneamente os corais que terminam em acordes diferentes da tônica, como os que terminam em meia-cadência. \begin{figure} \centering \includegraphics[scale=3]{341-99-104-cadencia} \caption{Cadência} \label{fig:cadencia} \end{figure} \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex %%% TeX-master: "musicologia-computacional-anppom" %%% End:
mdsmus/musicologia-computacional
ce2067987df4778d9bfeb02e5d61843e9368ae77
Insere referências e captions de figuras
diff --git a/body-pt.tex b/body-pt.tex index 599a0cc..ec4a800 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,275 +1,290 @@ \section{Introdução} \label{sec:introducao} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais ficaram de fora por problemas na conversão de MIDI para lilypond (ver seção \ref{sec:metodologia}). Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos musicais usuais em classes de harmonia. Nesse trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o sistema \rameau{}\footnote{Èstá descrito em outro trabalho do autor, a citação foi removida por anonimato e será acrescentada na ocasião da publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa cada conjunto de notas a um acorde. Para este trabalho, o \rameau{} foi extendido para realizar operações comuns de musicologia, como detecção de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, etc. Além disso \rameau{} possui vários outros algoritmos para análise harmônica, como o de Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para o lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos profissionais e não pela congregação \cite{bach41:371}. Isso \note{nao começa com isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos por KP e os utilizados por Bach nos corais analizados. Bach amplia o âmbito de soprano e tenor em uma segunda maior ascendente, e o do contralto em uma segunda maior descendente. A voz do baixo tem ampliação de uma terça maior em ambas direções (comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais onde as notas mais agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo -estão acima da voz do contralto) \note{fig}, e no coral 290 existe um -cruzamento simultâneo de baixo com o tenor e do contralto com o -soprano \note{fig}. +estão acima da voz do contralto) \ref{fig:035-cruzamento}, e no coral +290 existe um cruzamento simultâneo de baixo com o tenor e do +contralto com o soprano \ref{fig:290-66-74-cruzamento}. \begin{figure} \centering - \includegraphics[scale=3]{003-38-42-cruzamento} - \caption{aa} + \subfigure[Coral 35]{ + \includegraphics[scale=3]{035-cruzamento} + \label{fig:035-cruzamento} + } + \subfigure[Coral 290]{ + \includegraphics[scale=3]{290-66-74-cruzamento} + \label{fig:290-66-74-cruzamento} + } + \subfigure[Coral 3]{ + \includegraphics[scale=3]{003-38-42-cruzamento} + \label{fig:003-38-42-cruzamento} + } + \caption{Cruzamentos entre vozes} \label{fig:coral-003} \end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar quintas e oitavas consecutivas \note{fig} e para manter melhor condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma frase e primeiro acorde da próxima. Isso ocorre nos corais 45 e 46 -(quintas) e 2, 89, e 279 (oitavas). \note{fig} Uma possível -justificativa é a ``quebra'' de uma frase para outra. Contudo, a -maioria das quintas e oitavas consecutivas (9 no total) ocorrem no -meio de frases. Todas as oitavas nessa categoria são uníssono--oitava -ou oitava--uníssono \note{fig}. Para o alívio dos professores de +(quintas) e 2, 89, e 279 (oitavas). (vide figura \ref{fig:279-oitava}) +Uma possível justificativa é a ``quebra'' de uma frase para +outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no +total) ocorrem no meio de frases. Todas as oitavas nessa categoria são +uníssono--oitava ou oitava--uníssono (vide figura +\ref{fig:oitavas-e-unissonos}). Para o alívio dos professores de harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, 266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} + \label{fig:244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} + \label{fig:279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} + \label{fig:329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de -sexta aumentada francesa \note{fig:sextas-aumentadas}. +sexta aumentada francesa (vide figura\ref{fig:sextas-aumentadas}). \begin{figure} \centering \subfigure[Sexta alemã]{ \includegraphics[scale=3]{340-52-55-alema} } \subfigure[Sexta italiana]{ \includegraphics[scale=3]{019-4-6-italiana} } \caption{Sextas aumentadas} \label{fig:sextas-aumentadas} \end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. Verificamos o tratamento destas sétimas em segmentos adjacentes. Em 77\% dos casos as sétimas são resolvidas descendentemente e por grau conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde de bm7 se transforma na tônica do acorde seguinte, de $A$. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos corais. Por exemplo, a cadência final do coral 362 é I$^6_4$ V7 I, mas o algoritmo interpreta a antecipação para a terça do acorde final como um acorde menor do terceiro grau (iii). Além disso, como o algoritmo sempre considera que o acorde final é de tônica, ele classifica eroneamente os corais que terminam em acordes diferentes da tônica, como os que terminam em meia-cadência. \begin{figure} \centering \includegraphics[scale=3]{341-99-104-cadencia} \caption{Cadência} \label{fig:cadencia} \end{figure} \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex %%% TeX-master: "musicologia-computacional-anppom" %%% End:
mdsmus/musicologia-computacional
620fb2feb4c4b4996eea58cb34e2c8edbdb7911e
Insere figuras no texto
diff --git a/body-pt.tex b/body-pt.tex index b8c53c1..599a0cc 100644 --- a/body-pt.tex +++ b/body-pt.tex @@ -1,256 +1,275 @@ \section{Introdução} \label{sec:introducao} Neste trabalho apresentamos o estudo de âmbitos, cruzamento de vozes, quintas e oitavas consecutivas, acordes de sexta aumentada, resoluções de sétimas, e estudo das cadências finais em 366 dos 371 corais de Bach na edição de Riemenschneider \cite{bach41:371}. Cinco corais ficaram de fora por problemas na conversão de MIDI para lilypond (ver seção \ref{sec:metodologia}). Kostka e Payne \cite{kostka.ea00:tonal} foi usado como livro-texto base para comparações de procedimentos musicais usuais em classes de harmonia. Nesse trabalho o livro é referido no singular por KP. \section{Metodologia} \label{sec:metodologia} Todo o trabalho descrito neste artigo foi desenvolvido usando o sistema \rameau{}\footnote{Èstá descrito em outro trabalho do autor, a citação foi removida por anonimato e será acrescentada na ocasião da publicação.} para análise automática de harmonia e extração de informação musical. \rameau{} é um framework para implementação de algoritmos de análise harmônica de partituras simbólicas. As partituras são guardadas em arquivos no formato Lilypond \cite{nienhuys.ea08:lilypond}, que permite diferenciação de notas enarmônicas e geração de partituras bem tipografadas. As notas são extraídas das partituras e apresentadas a uma rede neural, que associa cada conjunto de notas a um acorde. Para este trabalho, o \rameau{} foi extendido para realizar operações comuns de musicologia, como detecção de cruzamentos, quintas ou oitavas consecutivas, cadências frequentes, etc. Além disso \rameau{} possui vários outros algoritmos para análise harmônica, como o de Pardo e Birmingham \cite{pardo.ea00:automated}, outras redes neurais e classificadores de árvores de decisão e k-vizinhos-mais-próximos. Atualmente \rameau{} está sendo extendido para realizar análise funcional de qualquer peça tonal. Os corais utilizados neste artigo foram extraídos do formato MIDI para o lilypond por uma ferramenta automática e depois corrigidos manualmente para remover erros de enarmonia e notas incorretas. Usamos gabaritos manuais de análise harmônica para validar os algoritmos de análise, e o algoritmo escolhido para análise de cadências encontra corretamente em torno de 98\% dos acordes\footnote{Idem.}. \section{Análise} \label{sec:analise} \subsection{Âmbitos} \label{sec:ambitos} Os corais de Bach foram escritos para serem cantados por músicos profissionais e não pela congregação \cite{bach41:371}. Isso \note{nao começa com isso} se reflete na textura, cruzamentos e no âmbito vocal usado nos corais. A figura \ref{fig:ambito-kostka} mostra os âmbitos sugeridos por KP e os utilizados por Bach nos corais analizados. Bach amplia o âmbito de soprano e tenor em uma segunda maior ascendente, e o do contralto em uma segunda maior descendente. A voz do baixo tem ampliação de uma terça maior em ambas direções (comparando com KP). A tabela \ref{tab:notas-extremas} lista os corais onde as notas mais agudas e graves ocorrem em cada voz. \begin{table}[t] \begin{center} \begin{small} \begin{sc} \begin{tabular}{r|p{4cm}p{4cm}} & nota mais aguda & nota mais grave \\ \hline soprano & 116 254 282 298 331 334 & 186 034 050 068 075 223 049 070 100 165 185 197 214 325 348 158 175 205 239 352 087 110 244 \\ \aroundspace contralto & 024 028 033 036 057 058 069 078 084 123 217 225 248 252 329 331 334 354 359 & 345 186 \\ \aroundspace tenor & 024 043 074 083 151 156 224 248 263 264 273 276 281 329 354 371 & 229 070 205 \\ \aroundspace baixo & 285 312 331 & 034 051 214 223 340 131 328 143 155 197 205 219 241 187 235 319 337 240 070 075 165 175 239 \end{tabular} \caption{Corais com notas extremas} \label{tab:notas-extremas} \end{sc} \end{small} \end{center} \end{table} \begin{figure} \centering \includegraphics[scale=2.5]{ambitos} \caption{Comparação de âmbito utilizado por Bach e definido por KP} \label{fig:ambito-kostka} \end{figure} \subsection{Cruzamento de vozes} \label{sec:cruzamento-de-vozes} Dos corais analizados 209 tem cruzamentos entre as vozes (57\%). KP sugere evitar cruzamentos, principalmente acima do soprano ou abaixo do baixo. Eles permitem o cruzamento breve das linhas de contralto e tenor se existir uma razão musical \cite[p. 79]{kostka.ea00:tonal}. De fato, dos corais com cruzamento, o cruzamento mais comum é entre tenor e contralto (64,6\%), mas o cruzamento entre tenor e baixo é quase tão comum (60\%). O cruzamento entre contralto e soprano é menos frequente (14,8\%), mas existente, contrariando a regra de não cruzar acima do soprano. De qualquer forma, a grande maioria (85\%) dos cruzamentos são curtos (nunca maiores que dois tempos). A análise de cruzamentos mostra alguns exemplos interessantes: no coral 35 o contralto é a voz mais grave por um breve período de tempo (as vozes do tenor e baixo estão acima da voz do contralto) \note{fig}, e no coral 290 existe um cruzamento simultâneo de baixo com o tenor e do contralto com o soprano \note{fig}. -% \begin{figure} -% \centering -% \includegraphics{coral-003} -% \caption{aa} -% \label{fig:coral-003} -% \end{figure} +\begin{figure} + \centering + \includegraphics[scale=3]{003-38-42-cruzamento} + \caption{aa} + \label{fig:coral-003} +\end{figure} Os cruzamentos podem ser classificados em duas categorias; para evitar quintas e oitavas consecutivas \note{fig} e para manter melhor condução de vozes \note{fig}. Contudo inúmeros cruzamentos poderiam ser evitados. Em alguns corais com cruzamento entre baixo e tenor, por exemplo 29, 35 e 76, a edição usada sugere através de uma \textit{ossia} que as notas do baixo sejam cantadas uma oitava abaixo para evitar o cruzamento. Essa sugestão levanta a questão do porque Bach não escreveu as notas nessa oitava em primeiro lugar. \subsection{Quintas e oitavas consecutivas} \label{sec:quintas-e-oitavas} Apesar do uso de quintas e oitavas consecutivas ser relativamente comum na escrita instrumental, seu uso constitui uma das regras mais básicas a ser evitada no estudo de harmonia e contraponto. Dessa maneira, é interessante verificar quantas oitavas e quintas consecutivas existem nos corais de Bach. O número de oitavas e quintas juntos é pouco representativo (4\%) em comparação com todos os corais analisados. Existem 8 quintas e 7 oitavas consecutivas. Algumas dessas quintas e oitavas ocorrem entre o último acorde de uma frase e primeiro acorde da próxima. Isso ocorre nos corais 45 e 46 (quintas) e 2, 89, e 279 (oitavas). \note{fig} Uma possível justificativa é a ``quebra'' de uma frase para outra. Contudo, a maioria das quintas e oitavas consecutivas (9 no total) ocorrem no meio de frases. Todas as oitavas nessa categoria são uníssono--oitava ou oitava--uníssono \note{fig}. Para o alívio dos professores de harmonia, nenhuma dessas oitavas é paralela, mas algumas das quintas são: nos corais 4, 46, 71, 266. \begin{figure} \centering \subfigure[Coral 244]{ \includegraphics[scale=5]{244-oitava} } \qquad \subfigure[Coral 279]{ \includegraphics[scale=2.7]{279-oitava} } \qquad \subfigure[Coral 329]{ \includegraphics[scale=2.8]{329-oitava} } \caption{Oitavas e uníssonos} \label{fig:oitavas-e-unissonos} \end{figure} \subsection{Acordes de sexta aumentada} \label{sec:acordes-de-sexta} Os corais apresentam exatamente três acordes de sexta aumentada e exatamente um de cada tipo listado por KP: um acorde de sexta aumentada alemã, um acorde de sexta aumentada italiana, e um acorde de -sexta aumentada francesa \note{fig}. +sexta aumentada francesa \note{fig:sextas-aumentadas}. + +\begin{figure} + \centering + \subfigure[Sexta alemã]{ + \includegraphics[scale=3]{340-52-55-alema} + } + \subfigure[Sexta italiana]{ + \includegraphics[scale=3]{019-4-6-italiana} + } + \caption{Sextas aumentadas} + \label{fig:sextas-aumentadas} +\end{figure} \subsection{Resoluções de sétimas} \label{sec:setimas} Encontramos nos corais de Bach um total de 6297 acordes com sétima. Verificamos o tratamento destas sétimas em segmentos adjacentes. Em 77\% dos casos as sétimas são resolvidas descendentemente e por grau conjunto, ou seja, da maneira usual \cite[p. 207]{kostka.ea00:tonal}. Nos acordes restantes em geral ocorre uma das quatro situações seguintes: \begin{enumerate} \item A sétima não é resolvida e se transforma em nota do acorde seguinte, que pode ser a própria tétrade ou um novo acorde (16\% dos casos). Na figura \ref{fig:120-setima-koechlin} a sétima do acorde de bm7 se transforma na tônica do acorde seguinte, de $A$. \item No segmento seguinte à sétima, uma ou várias notas do acorde são tocadas antes da resolução, ou ainda a sétima desaparece. Na figura \ref{fig:049-setima-arpejo} há um arpejo antes da resolução. \item O encadeamento das vozes por grau conjunto transforma a tétrade em uma espécie de acorde de passagem. Dessa forma a sétima perde sua função original (vide vozes circuladas na figura \ref{fig:015-setima-acorde-pass}). \item A sétima é resolvida ascendentemente e cromaticamente, em geral como uma sensível local (menos de 1\% dos casos). Na figura \ref{fig:003-setima-asc-crom} a sétima ascende cromaticamente para a sensível da tônica do acorde seguinte, de E. \end{enumerate} \begin{figure} \centering \subfigure[Sétima transformada em nota do acorde seguinte]{ \includegraphics[scale=5]{120-setima-koechlin} \label{fig:120-setima-koechlin} } \subfigure[Arpejo antes da resolução]{ \includegraphics[scale=3]{049-setima-arpejo} \label{fig:049-setima-arpejo} } \subfigure[Vozes de passagem]{ \includegraphics[scale=5]{015-setima-acorde-pass} \label{fig:015-setima-acorde-pass} } \subfigure[Ascendente cromática]{ \includegraphics[scale=3]{003-setima-asc-crom} \label{fig:003-setima-asc-crom} } \caption{Resoluções de sétima} \label{fig:setima-resol} \end{figure} \subsection{Cadências finais} \label{sec:cadencias} \rameau{} identifica 79\% das cadências finais (isso é, os três ultimos acordes diferentes) com o formato $x$ V I onde $x$ pode ser ii (menor ou diminuto), IV (maior ou menor), V/V (dominante secundária), ou I (maior ou menor) e último acorde pode ser maior ou menor. A cadência mais comum é do tipo II V I (36\%), seguida por I V I (32\%). As cadências IV VI (6\%) e V/V V I (5\%) são estatisticamente insignificantes. Apenas 3\% dos corais tem a cadência vii°/V V I, e apenas 2\% to tipo viiø V I. Apesar do algoritmo para analisar as cadências finais ser relativamente ingênuo, ele identifica de maneira errada 16\% dos corais. Por exemplo, a cadência final do coral 362 é I$^6_4$ V7 I, mas o algoritmo interpreta a antecipação para a terça do acorde final como um acorde menor do terceiro grau (iii). Além disso, como o algoritmo sempre considera que o acorde final é de tônica, ele classifica eroneamente os corais que terminam em acordes diferentes da tônica, como os que terminam em meia-cadência. +\begin{figure} + \centering + \includegraphics[scale=3]{341-99-104-cadencia} + \caption{Cadência} + \label{fig:cadencia} +\end{figure} + \section{Avaliação} \label{sec:avaliacao} \section{Conclusão e trabalhos futuros} \label{sec:concl-e-trab} %%% Local Variables: %%% mode: latex %%% TeX-master: "musicologia-computacional-anppom" %%% End:
berry/Django-demo
f0f6689dd6b9910dc67aa51c6d6b820f1975dfe4
Fixed two small template issues. And fixed creating new clients.
diff --git a/djangodemo_db b/djangodemo_db index 5910f80..4531648 100644 Binary files a/djangodemo_db and b/djangodemo_db differ diff --git a/subjecten/urls.py b/subjecten/urls.py index 205a6ce..aee11b4 100644 --- a/subjecten/urls.py +++ b/subjecten/urls.py @@ -1,25 +1,26 @@ from django.conf.urls.defaults import * from djangodemo.zaken.models import Zaak from djangodemo.subjecten.models import Subject # list/detail van subjecten subjecten = Subject.objects.select_related().all() urlpatterns = patterns('django.views.generic.list_detail', (r'^$', 'object_list', { 'queryset': subjecten, 'template_name': 'subjecten/index.html', 'template_object_name': 'subject', 'paginate_by': 3}), (r'^(?P<object_id>\d+)/$', 'object_detail', { 'queryset': subjecten, 'template_name': 'subjecten/detail.html', 'template_object_name': 'subject'}), ) # CRUD pagina's subjecten en zaak functies bij subject urlpatterns += patterns('djangodemo.subjecten.views', + (r'^new/$', 'new'), (r'^(?P<subject_id>\d+)/(edit|wijzig)/$', 'edit'), (r'^(?P<subject_id>\d+)/zaken/$', 'zaken'), (r'^(?P<subject_id>\d+)/zaken/(new|nieuw)/$', 'new_zaak_for_subject'), ) diff --git a/templates/subjecten/edit_subject.html b/templates/subjecten/edit_subject.html index dfe3836..85e4f42 100644 --- a/templates/subjecten/edit_subject.html +++ b/templates/subjecten/edit_subject.html @@ -1,95 +1,96 @@ {% extends "base.html" %} {% load subjecten_extras %} {% block content %} <h2>Wijzig cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> {{ form.errors }} <form action="/subjecten/{{ subject.pk }}/edit/" method="post"> <table> <tr> <th>Details</th> </tr> <tr> <td> <span class="label">Naam:</span> {{ form.voorletters}} {{ form.tussenvoegsels }} {{ form.achternaam }} </td> </tr> <tr> <td> <span class="label">Burgerservicenummer: </span>{{ form.bsn }} </td> </tr> <tr> <td> <span class="label">Geboortedatum:</span> {{ form.geboortedatum }} </td> </tr> </table> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td> <span class="label">Straat:</span>{{ form.woonadres_straatnaam }} </td> <td> <span class="label">Straat:</span>{{ form.correspondentie_straatnaam }} </td> <tr> <td> <span class="label">Huisnummer:</span>{{ form.woonadres_huisnummer }} </td> <td> <span class="label">Huisnummer:</span>{{ form.correspondentie_huisnummer }} </td> </tr> <tr> <td> <span class="label">Huisnr. toevoeging:</span> {{ form.woonadres_huisnummer_toevoeging }} </td> <td> <span class="label">Huisnr. toevoeging:</span> {{ form.correspondentie_huisnummer_toevoeging }} </td> </tr> <tr> <td> <span class="label">Postcode:</span> {{ form.woonadres_postcode }} </td> <td> <span class="label">Postcode:</span> {{ form.correspondentie_postcode }} </td> </tr> + <tr> <td> <span class="label">Woonplaats:</span> {{ form.woonadres_woonplaats }} </td> <td> <span class="label">Woonplaats:</span> {{ form.correspondentie_woonplaats }} </td> </tr> </table> <table> <tr> <th>Contact</th> </tr> <tr> <td> <span class="label">e-mail:</span> {{ form.email }} </td> </tr> <tr> <td> <span class="label">telefoon:</span> {{ form.telefoonnummer }} </td> </tr> </table> <a href="/subjecten/{{ subject.pk }}/"><input type="button" value="Annuleer" /></a> <input type="submit" value="Bewaar" /> </form> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/new_subject.html b/templates/subjecten/new_subject.html index 0e730b2..1ed52a4 100644 --- a/templates/subjecten/new_subject.html +++ b/templates/subjecten/new_subject.html @@ -1,91 +1,92 @@ {% extends "base.html" %} {% block content %} <h2>Nieuwe cliënt opvoeren</h2> {{ form.errors }} <form action="/subjecten/new/" method="post"> <table> <tr> <th>Details</th> </tr> <tr> <td> <span class="label">Naam:</span> {{ form.voorletters}} {{ form.tussenvoegsels }} {{ form.achternaam }} </td> </tr> <tr> <td> <span class="label">Burgerservicenummer: </span>{{ form.bsn }} </td> </tr> <tr> <td> <span class="label">Geboortedatum:</span> {{ form.geboortedatum }} </td> </tr> </table> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td> <span class="label">Straat:</span>{{ form.woonadres_straatnaam }} </td> <td> <span class="label">Straat:</span>{{ form.correspondentie_straatnaam }} </td> <tr> <td> <span class="label">Huisnummer:</span>{{ form.woonadres_huisnummer }} </td> <td> <span class="label">Huisnummer:</span>{{ form.correspondentie_huisnummer }} </td> </tr> <tr> <td> <span class="label">Huisnr. toevoeging:</span> {{ form.woonadres_huisnummer_toevoeging }} </td> <td> <span class="label">Huisnr. toevoeging:</span> {{ form.correspondentie_huisnummer_toevoeging }} </td> </tr> <tr> <td> <span class="label">Postcode:</span> {{ form.woonadres_postcode }} </td> <td> <span class="label">Postcode:</span> {{ form.correspondentie_postcode }} </td> </tr> + <tr> <td> <span class="label">Woonplaats:</span> {{ form.woonadres_woonplaats }} </td> <td> <span class="label">Woonplaats:</span> {{ form.correspondentie_woonplaats }} </td> </tr> </table> <table> <tr> <th>Contact</th> </tr> <tr> <td> <span class="label">e-mail:</span> {{ form.email }} </td> </tr> <tr> <td> <span class="label">telefoon:</span> {{ form.telefoonnummer }} </td> </tr> </table> <a href="/subjecten/"><input type="button" value="Annuleer" /></a> <input type="submit" value="Bewaar" /> </form> {% endblock content %} \ No newline at end of file
berry/Django-demo
a6f078731e884ea6efb22fb143a7338a41a9cbd2
Fixed a couple of small url issues. And modified all absolute urls for use on my linux dev machine.
diff --git a/djangodemo_db b/djangodemo_db index d2e1b0b..5910f80 100644 Binary files a/djangodemo_db and b/djangodemo_db differ diff --git a/settings.py b/settings.py index 2fa194f..8b06b81 100644 --- a/settings.py +++ b/settings.py @@ -1,83 +1,83 @@ # Django settings for djangodemo project. DEBUG = True TEMPLATE_DEBUG = DEBUG ADMINS = ( # ('Your Name', '[email protected]'), ) MANAGERS = ADMINS DATABASE_ENGINE = 'django.db.backends.sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'. -DATABASE_NAME = '/Users/berry/git/djangodemo/djangodemo_db' # Or path to database file if using sqlite3. +DATABASE_NAME = '/home/berry/git/djangodemo/djangodemo_db' # Or path to database file if using sqlite3. DATABASE_USER = '' # Not used with sqlite3. DATABASE_PASSWORD = '' # Not used with sqlite3. DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3. DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3. # Local time zone for this installation. Choices can be found here: # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name # although not all choices may be available on all operating systems. # If running in a Windows environment this must be set to the same as your # system time zone. TIME_ZONE = 'America/Chicago' # Language code for this installation. All choices can be found here: # http://www.i18nguy.com/unicode/language-identifiers.html LANGUAGE_CODE = 'nl-nl' SITE_ID = 1 # If you set this to False, Django will make some optimizations so as not # to load the internationalization machinery. USE_I18N = True # Absolute path to the directory that holds media. # Example: "/home/media/media.lawrence.com/" MEDIA_ROOT = '' # URL that handles the media served from MEDIA_ROOT. Make sure to use a # trailing slash if there is a path component (optional in other cases). # Examples: "http://media.lawrence.com", "http://example.com/media/" MEDIA_URL = '' # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a # trailing slash. # Examples: "http://foo.com/media/", "/media/". ADMIN_MEDIA_PREFIX = '/static/admin/media/' # Make this unique, and don't share it with anybody. SECRET_KEY = 'u*onq-80ifbru9^h-y)n$l^rd_yr(#low#!lh+m%x)jsgzywzr' # List of callables that know how to import templates from various sources. TEMPLATE_LOADERS = ( 'django.template.loaders.filesystem.load_template_source', 'django.template.loaders.app_directories.load_template_source', # 'django.template.loaders.eggs.load_template_source', ) MIDDLEWARE_CLASSES = ( 'django.middleware.common.CommonMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', ) ROOT_URLCONF = 'djangodemo.urls' TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. - "/Users/berry/git/djangodemo/templates", + "/home/berry/git/djangodemo/templates", ) INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', 'djangodemo.zaken', ) diff --git a/subjecten/urls.py b/subjecten/urls.py index 0df52bb..205a6ce 100644 --- a/subjecten/urls.py +++ b/subjecten/urls.py @@ -1,25 +1,25 @@ from django.conf.urls.defaults import * from djangodemo.zaken.models import Zaak from djangodemo.subjecten.models import Subject # list/detail van subjecten subjecten = Subject.objects.select_related().all() urlpatterns = patterns('django.views.generic.list_detail', (r'^$', 'object_list', { 'queryset': subjecten, 'template_name': 'subjecten/index.html', 'template_object_name': 'subject', - 'paginate_by': 25}), + 'paginate_by': 3}), (r'^(?P<object_id>\d+)/$', 'object_detail', { 'queryset': subjecten, 'template_name': 'subjecten/detail.html', 'template_object_name': 'subject'}), ) # CRUD pagina's subjecten en zaak functies bij subject urlpatterns += patterns('djangodemo.subjecten.views', (r'^(?P<subject_id>\d+)/(edit|wijzig)/$', 'edit'), (r'^(?P<subject_id>\d+)/zaken/$', 'zaken'), (r'^(?P<subject_id>\d+)/zaken/(new|nieuw)/$', 'new_zaak_for_subject'), ) diff --git a/templates/base.html b/templates/base.html index a8c4c3e..7e13bd0 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,40 +1,40 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<!DOCTYPE html> <html> <head> <title>Demo Django &amp; Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css"> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css"> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css"> <![endif]--> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head> <body> <div class="container"> <div id="header"> <h1>Demo Zaakgericht Werken</h1> <p>Alle gegevens die hier getoond worden zijn fictief en uit de duim gezogen. Elke overeenkomst met de werkelijkheid berust op toeval.</p> </div> <div id="menu"> <h2>Menu</h2> <ul> - <li><a href="/subjecten">Cliënten</a></li> - <li><a href="/zaken">Zaken</a></li> + <li><a href="/subjecten/">Cliënten</a></li> + <li><a href="/zaken/">Zaken</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy; 2010 - My Business</li> </ul> </div> </div> </body> </html> \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html index 639c0e0..e18bb5f 100644 --- a/templates/subjecten/index.html +++ b/templates/subjecten/index.html @@ -1,44 +1,44 @@ {% extends "base.html" %} {% load subjecten_extras %} {% block content %} <h2>Lijst van cliënten</h2> <ul class="commandmenu"> <li>Acties:</li> <li><a href="/subjecten/new/">Cliënt opvoeren</a></li> </ul> <table> <tr> <th>Naam</th> <th>Burgerservicenummer</th> <th>Postcode</th> <th>Woonplaats</th> <th>Aantal zaken</th> </tr> {% for subject in subject_list %} <tr> - <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a> ({{ subject.geboortedatum|leeftijd }} jaar)</td> + <td><a href="/subjecten/{{ subject.id }}/">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a> ({{ subject.geboortedatum|leeftijd }} jaar)</td> <td>{{ subject.bsn}}</td> <td>{{ subject.woonadres_postcode }}</td> <td>{{ subject.woonadres_woonplaats|upper }}</td> <td><a href="/subjecten/{{ subject.id }}/zaken/">{{ subject.aantal_zaken }}</td> </tr> {% endfor %} </table> <div class="pagination"> <span class="step-links"> {% if page_obj.has_previous %} <a href="?page={{ page_obj.previous_page_number }}">vorige</a>&nbsp;- {% endif %} <span class="current"> Pagina {{ page_obj.number }} van {{ paginator.num_pages }} </span> {% if page_obj.has_next %} &nbsp;- <a href="?page={{ page_obj.next_page_number }}">volgende</a> {% endif %} </span> </div> {% endblock content %} \ No newline at end of file diff --git a/urls.py b/urls.py index 3a9aa9a..b27e59b 100644 --- a/urls.py +++ b/urls.py @@ -1,34 +1,34 @@ from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Zaken (r'^zaken/', include("djangodemo.zaken.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. - (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), - (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), + (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/home/berry/git/djangodemo/static'}), + (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/home/berry/git/djangodemo/static/images'}), )
berry/Django-demo
958381f590573570b5b7729542141407c6ba8039
Fixed static files admin site. Experiment with gevent server. Used generic list/detail view for subjecten and zaken list. Added function new zaak for subject. And added edit page for zaak.
diff --git a/djangodemo.tmproj b/djangodemo.tmproj new file mode 100644 index 0000000..788171e --- /dev/null +++ b/djangodemo.tmproj @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>documents</key> + <array> + <dict> + <key>filename</key> + <string>__init__.py</string> + </dict> + <dict> + <key>filename</key> + <string>__init__.pyc</string> + </dict> + <dict> + <key>filename</key> + <string>djangodemo_db</string> + </dict> + <dict> + <key>filename</key> + <string>gevent_server.py</string> + <key>lastUsed</key> + <date>2010-03-17T21:26:16Z</date> + </dict> + <dict> + <key>filename</key> + <string>manage.py</string> + </dict> + <dict> + <key>filename</key> + <string>README.markdown</string> + </dict> + <dict> + <key>filename</key> + <string>settings.py</string> + <key>lastUsed</key> + <date>2010-03-17T21:26:18Z</date> + </dict> + <dict> + <key>filename</key> + <string>settings.pyc</string> + </dict> + <dict> + <key>name</key> + <string>static</string> + <key>regexFolderFilter</key> + <string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string> + <key>sourceDirectory</key> + <string>static</string> + </dict> + <dict> + <key>expanded</key> + <true/> + <key>name</key> + <string>subjecten</string> + <key>regexFolderFilter</key> + <string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string> + <key>selected</key> + <true/> + <key>sourceDirectory</key> + <string>subjecten</string> + </dict> + <dict> + <key>name</key> + <string>templates</string> + <key>regexFolderFilter</key> + <string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string> + <key>sourceDirectory</key> + <string>templates</string> + </dict> + <dict> + <key>filename</key> + <string>urls.py</string> + <key>lastUsed</key> + <date>2010-03-17T21:26:18Z</date> + </dict> + <dict> + <key>filename</key> + <string>urls.pyc</string> + </dict> + </array> + <key>fileHierarchyDrawerWidth</key> + <integer>200</integer> + <key>metaData</key> + <dict/> + <key>showFileHierarchyDrawer</key> + <true/> + <key>windowFrame</key> + <string>{{38, 95}, {901, 746}}</string> +</dict> +</plist> diff --git a/djangodemo_db b/djangodemo_db index 4730498..d2e1b0b 100644 Binary files a/djangodemo_db and b/djangodemo_db differ diff --git a/gevent_server.py b/gevent_server.py new file mode 100644 index 0000000..97900a3 --- /dev/null +++ b/gevent_server.py @@ -0,0 +1,25 @@ +import os +import sys + +PORTNUMBER = 8088 +DJANGO_DIR = '/Users/berry/Django-1.1.1/' +PROJECT_DIR_NAME = 'djangodemo' + +# use insert instead of append to make sure that +# the directory is searched first. +# This prevents that a potential django directory within the +# python/site-packages is searched first. +sys.path.insert(0, DJANGO_DIR) +# also insert current projectdirectory and go on directory up +sys.path.insert(0, os.sep.join((os.path.dirname(os.path.abspath(__file__)).split(os.sep)[:-1]))) + +os.environ['DJANGO_SETTINGS_MODULE'] = '%s.settings' % PROJECT_DIR_NAME + +from gevent import monkey; monkey.patch_all() # see: http://www.gevent.org/ +from gevent import wsgi +import django.core.handlers.wsgi + +application = django.core.handlers.wsgi.WSGIHandler() + +print "Starting Gevent server on port: %s" % PORTNUMBER +wsgi.WSGIServer(('', PORTNUMBER), application).serve_forever() diff --git a/settings.py b/settings.py index 62f8d24..2fa194f 100644 --- a/settings.py +++ b/settings.py @@ -1,82 +1,83 @@ # Django settings for djangodemo project. DEBUG = True TEMPLATE_DEBUG = DEBUG ADMINS = ( # ('Your Name', '[email protected]'), ) MANAGERS = ADMINS DATABASE_ENGINE = 'django.db.backends.sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'. DATABASE_NAME = '/Users/berry/git/djangodemo/djangodemo_db' # Or path to database file if using sqlite3. DATABASE_USER = '' # Not used with sqlite3. DATABASE_PASSWORD = '' # Not used with sqlite3. DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3. DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3. # Local time zone for this installation. Choices can be found here: # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name # although not all choices may be available on all operating systems. # If running in a Windows environment this must be set to the same as your # system time zone. TIME_ZONE = 'America/Chicago' # Language code for this installation. All choices can be found here: # http://www.i18nguy.com/unicode/language-identifiers.html LANGUAGE_CODE = 'nl-nl' SITE_ID = 1 # If you set this to False, Django will make some optimizations so as not # to load the internationalization machinery. USE_I18N = True # Absolute path to the directory that holds media. # Example: "/home/media/media.lawrence.com/" MEDIA_ROOT = '' # URL that handles the media served from MEDIA_ROOT. Make sure to use a # trailing slash if there is a path component (optional in other cases). # Examples: "http://media.lawrence.com", "http://example.com/media/" MEDIA_URL = '' # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a # trailing slash. # Examples: "http://foo.com/media/", "/media/". -ADMIN_MEDIA_PREFIX = '/media/' +ADMIN_MEDIA_PREFIX = '/static/admin/media/' # Make this unique, and don't share it with anybody. SECRET_KEY = 'u*onq-80ifbru9^h-y)n$l^rd_yr(#low#!lh+m%x)jsgzywzr' # List of callables that know how to import templates from various sources. TEMPLATE_LOADERS = ( 'django.template.loaders.filesystem.load_template_source', 'django.template.loaders.app_directories.load_template_source', # 'django.template.loaders.eggs.load_template_source', ) MIDDLEWARE_CLASSES = ( 'django.middleware.common.CommonMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', ) ROOT_URLCONF = 'djangodemo.urls' TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', + 'djangodemo.zaken', ) diff --git a/static/admin/media/css/base.css b/static/admin/media/css/base.css new file mode 100644 index 0000000..7299c95 --- /dev/null +++ b/static/admin/media/css/base.css @@ -0,0 +1,746 @@ +/* + DJANGO Admin styles +*/ + +body { + margin: 0; + padding: 0; + font-size: 12px; + font-family: "Lucida Grande","DejaVu Sans","Bitstream Vera Sans",Verdana,Arial,sans-serif; + color: #333; + background: #fff; +} + +/* LINKS */ + +a:link, a:visited { + color: #5b80b2; + text-decoration: none; +} + +a:hover { + color: #036; +} + +a img { + border: none; +} + +a.section:link, a.section:visited { + color: white; + text-decoration: none; +} + +/* GLOBAL DEFAULTS */ + +p, ol, ul, dl { + margin: .2em 0 .8em 0; +} + +p { + padding: 0; + line-height: 140%; +} + +h1,h2,h3,h4,h5 { + font-weight: bold; +} + +h1 { + font-size: 18px; + color: #666; + padding: 0 6px 0 0; + margin: 0 0 .2em 0; +} + +h2 { + font-size: 16px; + margin: 1em 0 .5em 0; +} + +h2.subhead { + font-weight: normal; + margin-top: 0; +} + +h3 { + font-size: 14px; + margin: .8em 0 .3em 0; + color: #666; + font-weight: bold; +} + +h4 { + font-size: 12px; + margin: 1em 0 .8em 0; + padding-bottom: 3px; +} + +h5 { + font-size: 10px; + margin: 1.5em 0 .5em 0; + color: #666; + text-transform: uppercase; + letter-spacing: 1px; +} + +ul li { + list-style-type: square; + padding: 1px 0; +} + +ul.plainlist { + margin-left: 0 !important; +} + +ul.plainlist li { + list-style-type: none; +} + +li ul { + margin-bottom: 0; +} + +li, dt, dd { + font-size: 11px; + line-height: 14px; +} + +dt { + font-weight: bold; + margin-top: 4px; +} + +dd { + margin-left: 0; +} + +form { + margin: 0; + padding: 0; +} + +fieldset { + margin: 0; + padding: 0; +} + +blockquote { + font-size: 11px; + color: #777; + margin-left: 2px; + padding-left: 10px; + border-left: 5px solid #ddd; +} + +code, pre { + font-family: "Bitstream Vera Sans Mono", Monaco, "Courier New", Courier, monospace; + background: inherit; + color: #666; + font-size: 11px; +} + +pre.literal-block { + margin: 10px; + background: #eee; + padding: 6px 8px; +} + +code strong { + color: #930; +} + +hr { + clear: both; + color: #eee; + background-color: #eee; + height: 1px; + border: none; + margin: 0; + padding: 0; + font-size: 1px; + line-height: 1px; +} + +/* TEXT STYLES & MODIFIERS */ + +.small { + font-size: 11px; +} + +.tiny { + font-size: 10px; +} + +p.tiny { + margin-top: -2px; +} + +.mini { + font-size: 9px; +} + +p.mini { + margin-top: -3px; +} + +.help, p.help { + font-size: 10px !important; + color: #999; +} + +p img, h1 img, h2 img, h3 img, h4 img, td img { + vertical-align: middle; +} + +.quiet, a.quiet:link, a.quiet:visited { + color: #999 !important; + font-weight: normal !important; +} + +.quiet strong { + font-weight: bold !important; +} + +.float-right { + float: right; +} + +.float-left { + float: left; +} + +.clear { + clear: both; +} + +.align-left { + text-align: left; +} + +.align-right { + text-align: right; +} + +.example { + margin: 10px 0; + padding: 5px 10px; + background: #efefef; +} + +.nowrap { + white-space: nowrap; +} + +/* TABLES */ + +table { + border-collapse: collapse; + border-color: #ccc; +} + +td, th { + font-size: 11px; + line-height: 13px; + border-bottom: 1px solid #eee; + vertical-align: top; + padding: 5px; + font-family: "Lucida Grande", Verdana, Arial, sans-serif; +} + +th { + text-align: left; + font-size: 12px; + font-weight: bold; +} + +thead th, +tfoot td { + color: #666; + padding: 2px 5px; + font-size: 11px; + background: #e1e1e1 url(../img/admin/nav-bg.gif) top left repeat-x; + border-left: 1px solid #ddd; + border-bottom: 1px solid #ddd; +} + +tfoot td { + border-bottom: none; + border-top: 1px solid #ddd; +} + +thead th:first-child, +tfoot td:first-child { + border-left: none !important; +} + +thead th.optional { + font-weight: normal !important; +} + +fieldset table { + border-right: 1px solid #eee; +} + +tr.row-label td { + font-size: 9px; + padding-top: 2px; + padding-bottom: 0; + border-bottom: none; + color: #666; + margin-top: -1px; +} + +tr.alt { + background: #f6f6f6; +} + +.row1 { + background: #EDF3FE; +} + +.row2 { + background: white; +} + +/* SORTABLE TABLES */ + +thead th a:link, thead th a:visited { + color: #666; + display: block; +} + +table thead th.sorted { + background-position: bottom left !important; +} + +table thead th.sorted a { + padding-right: 13px; +} + +table thead th.ascending a { + background: url(../img/admin/arrow-down.gif) right .4em no-repeat; +} + +table thead th.descending a { + background: url(../img/admin/arrow-up.gif) right .4em no-repeat; +} + +/* ORDERABLE TABLES */ + +table.orderable tbody tr td:hover { + cursor: move; +} + +table.orderable tbody tr td:first-child { + padding-left: 14px; + background-image: url(../img/admin/nav-bg-grabber.gif); + background-repeat: repeat-y; +} + +table.orderable-initalized .order-cell, body>tr>td.order-cell { + display: none; +} + +/* FORM DEFAULTS */ + +input, textarea, select { + margin: 2px 0; + padding: 2px 3px; + vertical-align: middle; + font-family: "Lucida Grande", Verdana, Arial, sans-serif; + font-weight: normal; + font-size: 11px; +} + +textarea { + vertical-align: top !important; +} + +input[type=text], input[type=password], textarea, select, .vTextField { + border: 1px solid #ccc; +} + +/* FORM BUTTONS */ + +.button, input[type=submit], input[type=button], .submit-row input { + background: white url(../img/admin/nav-bg.gif) bottom repeat-x; + padding: 3px; + color: black; + border: 1px solid #bbb; + border-color: #ddd #aaa #aaa #ddd; +} + +.button:active, input[type=submit]:active, input[type=button]:active { + background-image: url(../img/admin/nav-bg-reverse.gif); + background-position: top; +} + +.button.default, input[type=submit].default, .submit-row input.default { + border: 2px solid #5b80b2; + background: #7CA0C7 url(../img/admin/default-bg.gif) bottom repeat-x; + font-weight: bold; + color: white; + float: right; +} + +.button.default:active, input[type=submit].default:active { + background-image: url(../img/admin/default-bg-reverse.gif); + background-position: top; +} + +/* MODULES */ + +.module { + border: 1px solid #ccc; + margin-bottom: 5px; + background: white; +} + +.module p, .module ul, .module h3, .module h4, .module dl, .module pre { + padding-left: 10px; + padding-right: 10px; +} + +.module blockquote { + margin-left: 12px; +} + +.module ul, .module ol { + margin-left: 1.5em; +} + +.module h3 { + margin-top: .6em; +} + +.module h2, .module caption, .inline-group h2 { + margin: 0; + padding: 2px 5px 3px 5px; + font-size: 11px; + text-align: left; + font-weight: bold; + background: #7CA0C7 url(../img/admin/default-bg.gif) top left repeat-x; + color: white; +} + +.module table { + border-collapse: collapse; +} + +/* MESSAGES & ERRORS */ + +ul.messagelist { + padding: 0 0 5px 0; + margin: 0; +} + +ul.messagelist li { + font-size: 12px; + display: block; + padding: 4px 5px 4px 25px; + margin: 0 0 3px 0; + border-bottom: 1px solid #ddd; + color: #666; + background: #ffc url(../img/admin/icon_success.gif) 5px .3em no-repeat; +} + +.errornote { + font-size: 12px !important; + display: block; + padding: 4px 5px 4px 25px; + margin: 0 0 3px 0; + border: 1px solid red; + color: red; + background: #ffc url(../img/admin/icon_error.gif) 5px .3em no-repeat; +} + +ul.errorlist { + margin: 0 !important; + padding: 0 !important; +} + +.errorlist li { + font-size: 12px !important; + display: block; + padding: 4px 5px 4px 25px; + margin: 0 0 3px 0; + border: 1px solid red; + color: white; + background: red url(../img/admin/icon_alert.gif) 5px .3em no-repeat; +} + +td ul.errorlist { + margin: 0 !important; + padding: 0 !important; +} + +td ul.errorlist li { + margin: 0 !important; +} + +.errors { + background: #ffc; +} + +.errors input, .errors select { + border: 1px solid red; +} + +div.system-message { + background: #ffc; + margin: 10px; + padding: 6px 8px; + font-size: .8em; +} + +div.system-message p.system-message-title { + padding: 4px 5px 4px 25px; + margin: 0; + color: red; + background: #ffc url(../img/admin/icon_error.gif) 5px .3em no-repeat; +} + +.description { + font-size: 12px; + padding: 5px 0 0 12px; +} + +/* BREADCRUMBS */ + +div.breadcrumbs { + background: white url(../img/admin/nav-bg-reverse.gif) 0 -10px repeat-x; + padding: 2px 8px 3px 8px; + font-size: 11px; + color: #999; + border-top: 1px solid white; + border-bottom: 1px solid #ccc; + text-align: left; +} + +/* ACTION ICONS */ + +.addlink { + padding-left: 12px; + background: url(../img/admin/icon_addlink.gif) 0 .2em no-repeat; +} + +.changelink { + padding-left: 12px; + background: url(../img/admin/icon_changelink.gif) 0 .2em no-repeat; +} + +.deletelink { + padding-left: 12px; + background: url(../img/admin/icon_deletelink.gif) 0 .25em no-repeat; +} + +a.deletelink:link, a.deletelink:visited { + color: #CC3434; +} + +a.deletelink:hover { + color: #993333; +} + +/* OBJECT TOOLS */ + +.object-tools { + font-size: 10px; + font-weight: bold; + font-family: Arial,Helvetica,sans-serif; + padding-left: 0; + float: right; + position: relative; + margin-top: -2.4em; + margin-bottom: -2em; +} + +.form-row .object-tools { + margin-top: 5px; + margin-bottom: 5px; + float: none; + height: 2em; + padding-left: 3.5em; +} + +.object-tools li { + display: block; + float: left; + background: url(../img/admin/tool-left.gif) 0 0 no-repeat; + padding: 0 0 0 8px; + margin-left: 2px; + height: 16px; +} + +.object-tools li:hover { + background: url(../img/admin/tool-left_over.gif) 0 0 no-repeat; +} + +.object-tools a:link, .object-tools a:visited { + display: block; + float: left; + color: white; + padding: .1em 14px .1em 8px; + height: 14px; + background: #999 url(../img/admin/tool-right.gif) 100% 0 no-repeat; +} + +.object-tools a:hover, .object-tools li:hover a { + background: #5b80b2 url(../img/admin/tool-right_over.gif) 100% 0 no-repeat; +} + +.object-tools a.viewsitelink, .object-tools a.golink { + background: #999 url(../img/admin/tooltag-arrowright.gif) top right no-repeat; + padding-right: 28px; +} + +.object-tools a.viewsitelink:hover, .object-tools a.golink:hover { + background: #5b80b2 url(../img/admin/tooltag-arrowright_over.gif) top right no-repeat; +} + +.object-tools a.addlink { + background: #999 url(../img/admin/tooltag-add.gif) top right no-repeat; + padding-right: 28px; +} + +.object-tools a.addlink:hover { + background: #5b80b2 url(../img/admin/tooltag-add_over.gif) top right no-repeat; +} + +/* OBJECT HISTORY */ + +table#change-history { + width: 100%; +} + +table#change-history tbody th { + width: 16em; +} + +/* PAGE STRUCTURE */ + +#container { + position: relative; + width: 100%; + min-width: 760px; + padding: 0; +} + +#content { + margin: 10px 15px; +} + +#header { + width: 100%; +} + +#content-main { + float: left; + width: 100%; +} + +#content-related { + float: right; + width: 18em; + position: relative; + margin-right: -19em; +} + +#footer { + clear: both; + padding: 10px; +} + +/* COLUMN TYPES */ + +.colMS { + margin-right: 20em !important; +} + +.colSM { + margin-left: 20em !important; +} + +.colSM #content-related { + float: left; + margin-right: 0; + margin-left: -19em; +} + +.colSM #content-main { + float: right; +} + +.popup .colM { + width: 95%; +} + +.subcol { + float: left; + width: 46%; + margin-right: 15px; +} + +.dashboard #content { + width: 500px; +} + +/* HEADER */ + +#header { + background: #417690; + color: #ffc; + overflow: hidden; +} + +#header a:link, #header a:visited { + color: white; +} + +#header a:hover { + text-decoration: underline; +} + +#branding h1 { + padding: 0 10px; + font-size: 18px; + margin: 8px 0; + font-weight: normal; + color: #f4f379; +} + +#branding h2 { + padding: 0 10px; + font-size: 14px; + margin: -8px 0 8px 0; + font-weight: normal; + color: #ffc; +} + +#user-tools { + position: absolute; + top: 0; + right: 0; + padding: 1.2em 10px; + font-size: 11px; + text-align: right; +} + +/* SIDEBAR */ + +#content-related h3 { + font-size: 12px; + color: #666; + margin-bottom: 3px; +} + +#content-related h4 { + font-size: 11px; +} + +#content-related .module h2 { + background: #eee url(../img/admin/nav-bg.gif) bottom left repeat-x; + color: #666; +} + diff --git a/static/admin/media/css/changelists.css b/static/admin/media/css/changelists.css new file mode 100644 index 0000000..5eb66b4 --- /dev/null +++ b/static/admin/media/css/changelists.css @@ -0,0 +1,269 @@ +/* CHANGELISTS */ + +#changelist { + position: relative; + width: 100%; +} + +#changelist table { + width: 100%; +} + +.change-list .filtered table { + border-right: 1px solid #ddd; +} + +.change-list .filtered { + min-height: 400px; +} + +.change-list .filtered { + background: white url(../img/admin/changelist-bg.gif) top right repeat-y !important; +} + +.change-list .filtered table, .change-list .filtered .paginator, .filtered #toolbar, .filtered div.xfull { + margin-right: 160px !important; + width: auto !important; +} + +.change-list .filtered table tbody th { + padding-right: 1em; +} + +#changelist .toplinks { + border-bottom: 1px solid #ccc !important; +} + +#changelist .paginator { + color: #666; + border-top: 1px solid #eee; + border-bottom: 1px solid #eee; + background: white url(../img/admin/nav-bg.gif) 0 180% repeat-x; + overflow: hidden; +} + +.change-list .filtered .paginator { + border-right: 1px solid #ddd; +} + +/* CHANGELIST TABLES */ + +#changelist table thead th { + white-space: nowrap; + vertical-align: middle; +} + +#changelist table thead th:first-child { + width: 1.5em; + text-align: center; +} + +#changelist table tbody td { + border-left: 1px solid #ddd; +} + +#changelist table tbody td:first-child { + border-left: 0; + border-right: 1px solid #ddd; + text-align: center; +} + +#changelist table tfoot { + color: #666; +} + +/* TOOLBAR */ + +#changelist #toolbar { + padding: 3px; + border-bottom: 1px solid #ddd; + background: #e1e1e1 url(../img/admin/nav-bg.gif) top left repeat-x; + color: #666; +} + +#changelist #toolbar form input { + font-size: 11px; + padding: 1px 2px; +} + +#changelist #toolbar form #searchbar { + padding: 2px; +} + +#changelist #changelist-search img { + vertical-align: middle; +} + +/* FILTER COLUMN */ + +#changelist-filter { + position: absolute; + top: 0; + right: 0; + z-index: 1000; + width: 160px; + border-left: 1px solid #ddd; + background: #efefef; + margin: 0; +} + +#changelist-filter h2 { + font-size: 11px; + padding: 2px 5px; + border-bottom: 1px solid #ddd; +} + +#changelist-filter h3 { + font-size: 12px; + margin-bottom: 0; +} + +#changelist-filter ul { + padding-left: 0; + margin-left: 10px; +} + +#changelist-filter li { + list-style-type: none; + margin-left: 0; + padding-left: 0; +} + +#changelist-filter a { + color: #999; +} + +#changelist-filter a:hover { + color: #036; +} + +#changelist-filter li.selected { + border-left: 5px solid #ccc; + padding-left: 5px; + margin-left: -10px; +} + +#changelist-filter li.selected a { + color: #5b80b2 !important; +} + +/* DATE DRILLDOWN */ + +.change-list ul.toplinks { + display: block; + background: white url(../img/admin/nav-bg-reverse.gif) 0 -10px repeat-x; + border-top: 1px solid white; + float: left; + padding: 0 !important; + margin: 0 !important; + width: 100%; +} + +.change-list ul.toplinks li { + float: left; + width: 9em; + padding: 3px 6px; + font-weight: bold; + list-style-type: none; +} + +.change-list ul.toplinks .date-back a { + color: #999; +} + +.change-list ul.toplinks .date-back a:hover { + color: #036; +} + +/* PAGINATOR */ + +.paginator { + font-size: 11px; + padding-top: 10px; + padding-bottom: 10px; + line-height: 22px; + margin: 0; + border-top: 1px solid #ddd; +} + +.paginator a:link, .paginator a:visited { + padding: 2px 6px; + border: solid 1px #ccc; + background: white; + text-decoration: none; +} + +.paginator a.showall { + padding: 0 !important; + border: none !important; +} + +.paginator a.showall:hover { + color: #036 !important; + background: transparent !important; +} + +.paginator .end { + border-width: 2px !important; + margin-right: 6px; +} + +.paginator .this-page { + padding: 2px 6px; + font-weight: bold; + font-size: 13px; + vertical-align: top; +} + +.paginator a:hover { + color: white; + background: #5b80b2; + border-color: #036; +} + +/* ACTIONS */ + +.filtered .actions { + margin-right: 160px !important; + border-right: 1px solid #ddd; +} + +#changelist table input { + margin: 0; +} + +#changelist table tbody tr.selected { + background-color: #FFFFCC; +} + +#changelist .actions { + color: #999; + padding: 3px; + border-top: 1px solid #fff; + border-bottom: 1px solid #ddd; + background: white url(../img/admin/nav-bg-reverse.gif) 0 -10px repeat-x; +} + +#changelist .actions:last-child { + border-bottom: none; +} + +#changelist .actions select { + border: 1px solid #aaa; + margin-left: 0.5em; + padding: 1px 2px; +} + +#changelist .actions label { + font-size: 11px; + margin-left: 0.5em; +} + +#changelist #action-toggle { + display: none; +} + +#changelist .actions .button { + font-size: 11px; + padding: 1px 2px; +} diff --git a/static/admin/media/css/dashboard.css b/static/admin/media/css/dashboard.css new file mode 100644 index 0000000..88e3b1d --- /dev/null +++ b/static/admin/media/css/dashboard.css @@ -0,0 +1,24 @@ +/* DASHBOARD */ + +.dashboard .module table th { + width: 100%; +} + +.dashboard .module table td { + white-space: nowrap; +} + +.dashboard .module table td a { + display: block; + padding-right: .6em; +} + +/* RECENT ACTIONS MODULE */ + +.module ul.actionlist { + margin-left: 0; +} + +ul.actionlist li { + list-style-type: none; +} diff --git a/static/admin/media/css/forms.css b/static/admin/media/css/forms.css new file mode 100644 index 0000000..fbe4b75 --- /dev/null +++ b/static/admin/media/css/forms.css @@ -0,0 +1,327 @@ +@import url('widgets.css'); + +/* FORM ROWS */ + +.form-row { + overflow: hidden; + padding: 8px 12px; + font-size: 11px; + border-bottom: 1px solid #eee; +} + +.form-row img, .form-row input { + vertical-align: middle; +} + +form .form-row p { + padding-left: 0; + font-size: 11px; +} + +/* FORM LABELS */ + +form h4 { + margin: 0 !important; + padding: 0 !important; + border: none !important; +} + +label { + font-weight: normal !important; + color: #666; + font-size: 12px; +} + +.required label, label.required { + font-weight: bold !important; + color: #333 !important; +} + +/* RADIO BUTTONS */ + +form ul.radiolist li { + list-style-type: none; +} + +form ul.radiolist label { + float: none; + display: inline; +} + +form ul.inline { + margin-left: 0; + padding: 0; +} + +form ul.inline li { + float: left; + padding-right: 7px; +} + +/* ALIGNED FIELDSETS */ + +.aligned label { + display: block; + padding: 3px 10px 0 0; + float: left; + width: 8em; +} + +.colMS .aligned .vLargeTextField, .colMS .aligned .vXMLLargeTextField { + width: 350px; +} + +form .aligned p, form .aligned ul { + margin-left: 7em; + padding-left: 30px; +} + +form .aligned table p { + margin-left: 0; + padding-left: 0; +} + +form .aligned p.help { + padding-left: 38px; +} + +.aligned .vCheckboxLabel { + float: none !important; + display: inline; + padding-left: 4px; +} + +.colM .aligned .vLargeTextField, .colM .aligned .vXMLLargeTextField { + width: 610px; +} + +.checkbox-row p.help { + margin-left: 0; + padding-left: 0 !important; +} + +fieldset .field-box { + float: left; + margin-right: 20px; +} + +/* WIDE FIELDSETS */ + +.wide label { + width: 15em !important; +} + +form .wide p { + margin-left: 15em; +} + +form .wide p.help { + padding-left: 38px; +} + +.colM fieldset.wide .vLargeTextField, .colM fieldset.wide .vXMLLargeTextField { + width: 450px; +} + +/* COLLAPSED FIELDSETS */ + +fieldset.collapsed * { + display: none; +} + +fieldset.collapsed h2, fieldset.collapsed { + display: block !important; +} + +fieldset.collapsed h2 { + background-image: url(../img/admin/nav-bg.gif); + background-position: bottom left; + color: #999; +} + +fieldset.collapsed .collapse-toggle { + padding: 3px 5px !important; + background: transparent; + display: inline !important; +} + +/* MONOSPACE TEXTAREAS */ + +fieldset.monospace textarea { + font-family: "Bitstream Vera Sans Mono",Monaco,"Courier New",Courier,monospace; +} + +/* SUBMIT ROW */ + +.submit-row { + padding: 5px 7px; + text-align: right; + background: white url(../img/admin/nav-bg.gif) 0 100% repeat-x; + border: 1px solid #ccc; + margin: 5px 0; + overflow: hidden; +} + +.submit-row input { + margin: 0 0 0 5px; +} + +.submit-row p { + margin: 0.3em; +} + +.submit-row p.deletelink-box { + float: left; +} + +.submit-row .deletelink { + background: url(../img/admin/icon_deletelink.gif) 0 50% no-repeat; + padding-left: 14px; +} + +/* CUSTOM FORM FIELDS */ + +.vSelectMultipleField { + vertical-align: top !important; +} + +.vCheckboxField { + border: none; +} + +.vDateField, .vTimeField { + margin-right: 2px; +} + +.vURLField { + width: 30em; +} + +.vLargeTextField, .vXMLLargeTextField { + width: 48em; +} + +.flatpages-flatpage #id_content { + height: 40.2em; +} + +.module table .vPositiveSmallIntegerField { + width: 2.2em; +} + +.vTextField { + width: 20em; +} + +.vIntegerField { + width: 5em; +} + +.vForeignKeyRawIdAdminField { + width: 5em; +} + +/* INLINES */ + +.inline-group { + padding: 0; + border: 1px solid #ccc; + margin: 10px 0; +} + +.inline-group .aligned label { + width: 8em; +} + +.inline-related { + position: relative; +} + +.inline-related h3 { + margin: 0; + color: #666; + padding: 3px 5px; + font-size: 11px; + background: #e1e1e1 url(../img/admin/nav-bg.gif) top left repeat-x; + border-bottom: 1px solid #ddd; +} + +.inline-related h3 span.delete { + padding-left: 20px; + position: absolute; + top: 2px; + right: 10px; +} + +.inline-related h3 span.delete label { + margin-left: 2px; + font-size: 11px; +} + +.inline-related fieldset { + margin: 0; + background: #fff; + border: none; +} + +.inline-related fieldset.module h3 { + margin: 0; + padding: 2px 5px 3px 5px; + font-size: 11px; + text-align: left; + font-weight: bold; + background: #bcd; + color: #fff; +} + +.inline-related.tabular fieldset.module table { + width: 100%; +} + +.last-related fieldset { + border: none; +} + +.inline-group .tabular tr.has_original td { + padding-top: 2em; +} + +.inline-group .tabular tr td.original { + padding: 2px 0 0 0; + width: 0; + _position: relative; +} + +.inline-group .tabular th.original { + width: 0px; + padding: 0; +} + +.inline-group .tabular td.original p { + position: absolute; + left: 0; + height: 1.1em; + padding: 2px 7px; + overflow: hidden; + font-size: 9px; + font-weight: bold; + color: #666; + _width: 700px; +} + +.inline-group ul.tools { + padding: 0; + margin: 0; + list-style: none; +} + +.inline-group ul.tools li { + display: inline; + padding: 0 5px; +} + +.inline-group ul.tools a.add { + background: url(../img/admin/icon_addlink.gif) 0 50% no-repeat; + padding-left: 14px; +} + diff --git a/static/admin/media/css/ie.css b/static/admin/media/css/ie.css new file mode 100644 index 0000000..30a08e4 --- /dev/null +++ b/static/admin/media/css/ie.css @@ -0,0 +1,51 @@ +/* IE 6 & 7 */ + +/* Proper fixed width for dashboard in IE6 */ + +.dashboard #content { + *width: 768px; +} + +.dashboard #content-main { + *width: 535px; +} + +/* IE 6 ONLY */ + +/* Keep header from flowing off the page */ + +#container { + _position: static; +} + +/* Put the right sidebars back on the page */ + +.colMS #content-related { + _margin-right: 0; + _margin-left: 10px; + _position: static; +} + +/* Put the left sidebars back on the page */ + +.colSM #content-related { + _margin-right: 10px; + _margin-left: -115px; + _position: static; +} + +.form-row { + _height: 1%; +} + +/* Fix right margin for changelist filters in IE6 */ + +#changelist-filter ul { + _margin-right: -10px; +} + +/* IE ignores min-height, but treats height as if it were min-height */ + +.change-list .filtered { + _height: 400px; +} \ No newline at end of file diff --git a/static/admin/media/css/login.css b/static/admin/media/css/login.css new file mode 100644 index 0000000..8d90d12 --- /dev/null +++ b/static/admin/media/css/login.css @@ -0,0 +1,54 @@ +/* LOGIN FORM */ + +body.login { + background: #eee; +} + +.login #container { + background: white; + border: 1px solid #ccc; + width: 28em; + min-width: 300px; + margin-left: auto; + margin-right: auto; + margin-top: 100px; +} + +.login #content-main { + width: 100%; +} + +.login form { + margin-top: 1em; +} + +.login .form-row { + padding: 4px 0; + float: left; + width: 100%; +} + +.login .form-row label { + float: left; + width: 9em; + padding-right: 0.5em; + line-height: 2em; + text-align: right; + font-size: 1em; + color: #333; +} + +.login .form-row #id_username, .login .form-row #id_password { + width: 14em; +} + +.login span.help { + font-size: 10px; + display: block; +} + +.login .submit-row { + clear: both; + padding: 1em 0 0 9.4em; +} + diff --git a/static/admin/media/css/rtl.css b/static/admin/media/css/rtl.css new file mode 100644 index 0000000..6819a23 --- /dev/null +++ b/static/admin/media/css/rtl.css @@ -0,0 +1,206 @@ +body { + direction: rtl; +} + +/* LOGIN */ + +.login .form-row { + float: right; +} + +.login .form-row label { + float: right; + padding-left: 0.5em; + padding-right: 0; + text-align: left; +} + +.login .submit-row { + clear: both; + padding: 1em 9.4em 0 0; +} + +/* GLOBAL */ + +th { + text-align: right; +} + +.module h2, .module caption { + text-align: right; +} + +.addlink, .changelink { + padding-left: 0px; + padding-right: 12px; + background-position: 100% 0.2em; +} + +.deletelink { + padding-left: 0px; + padding-right: 12px; + background-position: 100% 0.25em; +} + +.object-tools { + float: left; +} + +/* LAYOUT */ + +#user-tools { + right: auto; + left: 0; + text-align: left; +} + +div.breadcrumbs { + text-align: right; +} + +#content-main { + float: right; +} + +#content-related { + float: left; + margin-left: -19em; + margin-right: auto; +} + +.colMS { + margin-left: 20em !important; + margin-right: 10px !important; +} + +/* dashboard styles */ + +.dashboard .module table td a { + padding-left: .6em; + padding-right: 12px; +} + +/* changelists styles */ + +.change-list .filtered { + background: white url(../img/admin/changelist-bg_rtl.gif) top left repeat-y !important; +} + +.change-list .filtered table { + border-left: 1px solid #ddd; + border-right: 0px none; +} + +#changelist-filter { + right: auto; + left: 0; + border-left: 0px none; + border-right: 1px solid #ddd; +} + +.change-list .filtered table, .change-list .filtered .paginator, .filtered #toolbar, .filtered div.xfull { + margin-right: 0px !important; + margin-left: 160px !important; +} + +#changelist-filter li.selected { + border-left: 0px none; + padding-left: 0px; + margin-left: 0; + border-right: 5px solid #ccc; + padding-right: 5px; + margin-right: -10px; +} + +/* FORMS */ + +.aligned label { + padding: 0 0 3px 1em; + float: right; +} + +.submit-row { + text-align: left +} + +.submit-row p.deletelink-box { + float: right; +} + +.submit-row .deletelink { + background: url(../img/admin/icon_deletelink.gif) 0 50% no-repeat; + padding-right: 14px; +} + +.vDateField, .vTimeField { + margin-left: 2px; +} + +form ul.inline li { + float: right; + padding-right: 0; + padding-left: 7px; +} + +input[type=submit].default, .submit-row input.default { + float: left; +} + +fieldset .field-box { + float: right; + margin-left: 20px; +} + +.errorlist li { + background-position: 100% .3em; + padding: 4px 25px 4px 5px; +} + +.errornote { + background-position: 100% .3em; + padding: 4px 25px 4px 5px; +} + +/* WIDGETS */ + +.calendarnav-previous { + top: 0; + left: auto; + right: 0; +} + +.calendarnav-next { + top: 0; + right: auto; + left: 0; +} + +.calendar caption, .calendarbox h2 { + text-align: center; +} + +.selector { + float: right; +} + +.selector .selector-filter { + text-align: right; +} + +/* MISC */ + +.inline-related h2 { + text-align: right +} + +.inline-related h3 span.delete { + padding-right: 20px; + padding-left: inherit; + left: 10px; + right: inherit; +} + +.inline-related h3 span.delete label { + margin-left: inherit; + margin-right: 2px; +} diff --git a/static/admin/media/css/widgets.css b/static/admin/media/css/widgets.css new file mode 100644 index 0000000..9f9e63e --- /dev/null +++ b/static/admin/media/css/widgets.css @@ -0,0 +1,506 @@ +/* SELECTOR (FILTER INTERFACE) */ + +.selector { + width: 580px; + float: left; +} + +.selector select { + width: 270px; + height: 17.2em; +} + +.selector-available, .selector-chosen { + float: left; + width: 270px; + text-align: center; + margin-bottom: 5px; +} + +.selector-available h2, .selector-chosen h2 { + border: 1px solid #ccc; +} + +.selector .selector-available h2 { + background: white url(../img/admin/nav-bg.gif) bottom left repeat-x; + color: #666; +} + +.selector .selector-filter { + background: white; + border: 1px solid #ccc; + border-width: 0 1px; + padding: 3px; + color: #999; + font-size: 10px; + margin: 0; + text-align: left; +} + +.selector .selector-chosen .selector-filter { + padding: 4px 5px; +} + +.selector .selector-available input { + width: 230px; +} + +.selector ul.selector-chooser { + float: left; + width: 22px; + height: 50px; + background: url(../img/admin/chooser-bg.gif) top center no-repeat; + margin: 8em 3px 0 3px; + padding: 0; +} + +.selector-chooser li { + margin: 0; + padding: 3px; + list-style-type: none; +} + +.selector select { + margin-bottom: 5px; + margin-top: 0; +} + +.selector-add, .selector-remove { + width: 16px; + height: 16px; + display: block; + text-indent: -3000px; +} + +.selector-add { + background: url(../img/admin/selector-add.gif) top center no-repeat; + margin-bottom: 2px; +} + +.selector-remove { + background: url(../img/admin/selector-remove.gif) top center no-repeat; +} + +a.selector-chooseall, a.selector-clearall { + display: block; + width: 6em; + text-align: left; + margin-left: auto; + margin-right: auto; + font-weight: bold; + color: #666; + padding: 3px 0 3px 18px; +} + +a.selector-chooseall:hover, a.selector-clearall:hover { + color: #036; +} + +a.selector-chooseall { + width: 7em; + background: url(../img/admin/selector-addall.gif) left center no-repeat; +} + +a.selector-clearall { + background: url(../img/admin/selector-removeall.gif) left center no-repeat; +} + + +/* STACKED SELECTORS */ + +.stacked { + float: left; + width: 500px; +} + +.stacked select { + width: 480px; + height: 10.1em; +} + +.stacked .selector-available, .stacked .selector-chosen { + width: 480px; +} + +.stacked .selector-available { + margin-bottom: 0; +} + +.stacked .selector-available input { + width: 442px; +} + +.stacked ul.selector-chooser { + height: 22px; + width: 50px; + margin: 0 0 3px 40%; + background: url(../img/admin/chooser_stacked-bg.gif) top center no-repeat; +} + +.stacked .selector-chooser li { + float: left; + padding: 3px 3px 3px 5px; +} + +.stacked .selector-chooseall, .stacked .selector-clearall { + display: none; +} + +.stacked .selector-add { + background-image: url(../img/admin/selector_stacked-add.gif); +} + +.stacked .selector-remove { + background-image: url(../img/admin/selector_stacked-remove.gif); +} + + +/* DATE AND TIME */ + +p.datetime { + line-height: 20px; + margin: 0; + padding: 0; + color: #666; + font-size: 11px; + font-weight: bold; +} + +.datetime span { + font-size: 11px; + color: #ccc; + font-weight: normal; + white-space: nowrap; +} + +table p.datetime { + font-size: 10px; + margin-left: 0; + padding-left: 0; +} + +/* FILE UPLOADS */ + +p.file-upload { + line-height: 20px; + margin: 0; + padding: 0; + color: #666; + font-size: 11px; + font-weight: bold; +} + +.file-upload a { + font-weight: normal; +} + +.file-upload .deletelink { + margin-left: 5px; +} + +/* CALENDARS & CLOCKS */ + +.calendarbox, .clockbox { + margin: 5px auto; + font-size: 11px; + width: 16em; + text-align: center; + background: white; + position: relative; +} + +.clockbox { + width: auto; +} + +.calendar { + margin: 0; + padding: 0; +} + +.calendar table { + margin: 0; + padding: 0; + border-collapse: collapse; + background: white; + width: 99%; +} + +.calendar caption, .calendarbox h2 { + margin: 0; + font-size: 11px; + text-align: center; + border-top: none; +} + +.calendar th { + font-size: 10px; + color: #666; + padding: 2px 3px; + text-align: center; + background: #e1e1e1 url(../img/admin/nav-bg.gif) 0 50% repeat-x; + border-bottom: 1px solid #ddd; +} + +.calendar td { + font-size: 11px; + text-align: center; + padding: 0; + border-top: 1px solid #eee; + border-bottom: none; +} + +.calendar td.selected a { + background: #C9DBED; +} + +.calendar td.nonday { + background: #efefef; +} + +.calendar td.today a { + background: #ffc; +} + +.calendar td a, .timelist a { + display: block; + font-weight: bold; + padding: 4px; + text-decoration: none; + color: #444; +} + +.calendar td a:hover, .timelist a:hover { + background: #5b80b2; + color: white; +} + +.calendar td a:active, .timelist a:active { + background: #036; + color: white; +} + +.calendarnav { + font-size: 10px; + text-align: center; + color: #ccc; + margin: 0; + padding: 1px 3px; +} + +.calendarnav a:link, #calendarnav a:visited, #calendarnav a:hover { + color: #999; +} + +.calendar-shortcuts { + background: white; + font-size: 10px; + line-height: 11px; + border-top: 1px solid #eee; + padding: 3px 0 4px; + color: #ccc; +} + +.calendarbox .calendarnav-previous, .calendarbox .calendarnav-next { + display: block; + position: absolute; + font-weight: bold; + font-size: 12px; + background: #C9DBED url(../img/admin/default-bg.gif) bottom left repeat-x; + padding: 1px 4px 2px 4px; + color: white; +} + +.calendarnav-previous:hover, .calendarnav-next:hover { + background: #036; +} + +.calendarnav-previous { + top: 0; + left: 0; +} + +.calendarnav-next { + top: 0; + right: 0; +} + +.calendar-cancel { + margin: 0 !important; + padding: 0; + font-size: 10px; + background: #e1e1e1 url(../img/admin/nav-bg.gif) 0 50% repeat-x; + border-top: 1px solid #ddd; +} + +.calendar-cancel a { + padding: 2px; + color: #999; +} + +ul.timelist, .timelist li { + list-style-type: none; + margin: 0; + padding: 0; +} + +.timelist a { + padding: 2px; +} + +/* INLINE ORDERER */ + +ul.orderer { + position: relative; + padding: 0 !important; + margin: 0 !important; + list-style-type: none; +} + +ul.orderer li { + list-style-type: none; + display: block; + padding: 0; + margin: 0; + border: 1px solid #bbb; + border-width: 0 1px 1px 0; + white-space: nowrap; + overflow: hidden; + background: #e2e2e2 url(../img/admin/nav-bg-grabber.gif) repeat-y; +} + +ul.orderer li:hover { + cursor: move; + background-color: #ddd; +} + +ul.orderer li a.selector { + margin-left: 12px; + overflow: hidden; + width: 83%; + font-size: 10px !important; + padding: 0.6em 0; +} + +ul.orderer li a:link, ul.orderer li a:visited { + color: #333; +} + +ul.orderer li .inline-deletelink { + position: absolute; + right: 4px; + margin-top: 0.6em; +} + +ul.orderer li.selected { + background-color: #f8f8f8; + border-right-color: #f8f8f8; +} + +ul.orderer li.deleted { + background: #bbb url(../img/admin/deleted-overlay.gif); +} + +ul.orderer li.deleted a:link, ul.orderer li.deleted a:visited { + color: #888; +} + +ul.orderer li.deleted .inline-deletelink { + background-image: url(../img/admin/inline-restore.png); +} + +ul.orderer li.deleted:hover, ul.orderer li.deleted a.selector:hover { + cursor: default; +} + +/* EDIT INLINE */ + +.inline-deletelink { + display: block; + text-indent: -9999px; + background: transparent url(../img/admin/inline-delete.png) no-repeat; + width: 15px; + height: 15px; + margin: 0.4em 0; + border: 0px none; +} + +.inline-deletelink:hover { + background-position: -15px 0; + cursor: pointer; +} + +.editinline button.addlink { + border: 0px none; + color: #5b80b2; + font-size: 100%; + cursor: pointer; +} + +.editinline button.addlink:hover { + color: #036; + cursor: pointer; +} + +.editinline table .help { + text-align: right; + float: right; + padding-left: 2em; +} + +.editinline tfoot .addlink { + white-space: nowrap; +} + +.editinline table thead th:last-child { + border-left: none; +} + +.editinline tr.deleted { + background: #ddd url(../img/admin/deleted-overlay.gif); +} + +.editinline tr.deleted .inline-deletelink { + background-image: url(../img/admin/inline-restore.png); +} + +.editinline tr.deleted td:hover { + cursor: default; +} + +.editinline tr.deleted td:first-child { + background-image: none !important; +} + +/* EDIT INLINE - STACKED */ + +.editinline-stacked { + min-width: 758px; +} + +.editinline-stacked .inline-object { + margin-left: 210px; + background: white; +} + +.editinline-stacked .inline-source { + float: left; + width: 200px; + background: #f8f8f8; +} + +.editinline-stacked .inline-splitter { + float: left; + width: 9px; + background: #f8f8f8 url(../img/admin/inline-splitter-bg.gif) 50% 50% no-repeat; + border-right: 1px solid #ccc; +} + +.editinline-stacked .controls { + clear: both; + background: #e1e1e1 url(../img/admin/nav-bg.gif) top left repeat-x; + padding: 3px 4px; + font-size: 11px; + border-top: 1px solid #ddd; +} + diff --git a/static/admin/media/img/admin/arrow-down.gif b/static/admin/media/img/admin/arrow-down.gif new file mode 100644 index 0000000..a967b9f Binary files /dev/null and b/static/admin/media/img/admin/arrow-down.gif differ diff --git a/static/admin/media/img/admin/arrow-up.gif b/static/admin/media/img/admin/arrow-up.gif new file mode 100644 index 0000000..3fe4851 Binary files /dev/null and b/static/admin/media/img/admin/arrow-up.gif differ diff --git a/static/admin/media/img/admin/changelist-bg.gif b/static/admin/media/img/admin/changelist-bg.gif new file mode 100644 index 0000000..7f46994 Binary files /dev/null and b/static/admin/media/img/admin/changelist-bg.gif differ diff --git a/static/admin/media/img/admin/changelist-bg_rtl.gif b/static/admin/media/img/admin/changelist-bg_rtl.gif new file mode 100644 index 0000000..2379712 Binary files /dev/null and b/static/admin/media/img/admin/changelist-bg_rtl.gif differ diff --git a/static/admin/media/img/admin/chooser-bg.gif b/static/admin/media/img/admin/chooser-bg.gif new file mode 100644 index 0000000..30e83c2 Binary files /dev/null and b/static/admin/media/img/admin/chooser-bg.gif differ diff --git a/static/admin/media/img/admin/chooser_stacked-bg.gif b/static/admin/media/img/admin/chooser_stacked-bg.gif new file mode 100644 index 0000000..5d104b6 Binary files /dev/null and b/static/admin/media/img/admin/chooser_stacked-bg.gif differ diff --git a/static/admin/media/img/admin/default-bg-reverse.gif b/static/admin/media/img/admin/default-bg-reverse.gif new file mode 100644 index 0000000..0873281 Binary files /dev/null and b/static/admin/media/img/admin/default-bg-reverse.gif differ diff --git a/static/admin/media/img/admin/default-bg.gif b/static/admin/media/img/admin/default-bg.gif new file mode 100644 index 0000000..003aeca Binary files /dev/null and b/static/admin/media/img/admin/default-bg.gif differ diff --git a/static/admin/media/img/admin/deleted-overlay.gif b/static/admin/media/img/admin/deleted-overlay.gif new file mode 100644 index 0000000..dc3828f Binary files /dev/null and b/static/admin/media/img/admin/deleted-overlay.gif differ diff --git a/static/admin/media/img/admin/icon-no.gif b/static/admin/media/img/admin/icon-no.gif new file mode 100644 index 0000000..1b4ee58 Binary files /dev/null and b/static/admin/media/img/admin/icon-no.gif differ diff --git a/static/admin/media/img/admin/icon-unknown.gif b/static/admin/media/img/admin/icon-unknown.gif new file mode 100644 index 0000000..cfd2b02 Binary files /dev/null and b/static/admin/media/img/admin/icon-unknown.gif differ diff --git a/static/admin/media/img/admin/icon-yes.gif b/static/admin/media/img/admin/icon-yes.gif new file mode 100644 index 0000000..7399282 Binary files /dev/null and b/static/admin/media/img/admin/icon-yes.gif differ diff --git a/static/admin/media/img/admin/icon_addlink.gif b/static/admin/media/img/admin/icon_addlink.gif new file mode 100644 index 0000000..ee70e1a Binary files /dev/null and b/static/admin/media/img/admin/icon_addlink.gif differ diff --git a/static/admin/media/img/admin/icon_alert.gif b/static/admin/media/img/admin/icon_alert.gif new file mode 100644 index 0000000..a1dde26 Binary files /dev/null and b/static/admin/media/img/admin/icon_alert.gif differ diff --git a/static/admin/media/img/admin/icon_calendar.gif b/static/admin/media/img/admin/icon_calendar.gif new file mode 100644 index 0000000..7587b30 Binary files /dev/null and b/static/admin/media/img/admin/icon_calendar.gif differ diff --git a/static/admin/media/img/admin/icon_changelink.gif b/static/admin/media/img/admin/icon_changelink.gif new file mode 100644 index 0000000..e1b9afd Binary files /dev/null and b/static/admin/media/img/admin/icon_changelink.gif differ diff --git a/static/admin/media/img/admin/icon_clock.gif b/static/admin/media/img/admin/icon_clock.gif new file mode 100644 index 0000000..ff2d57e Binary files /dev/null and b/static/admin/media/img/admin/icon_clock.gif differ diff --git a/static/admin/media/img/admin/icon_deletelink.gif b/static/admin/media/img/admin/icon_deletelink.gif new file mode 100644 index 0000000..72523e3 Binary files /dev/null and b/static/admin/media/img/admin/icon_deletelink.gif differ diff --git a/static/admin/media/img/admin/icon_error.gif b/static/admin/media/img/admin/icon_error.gif new file mode 100644 index 0000000..3730a00 Binary files /dev/null and b/static/admin/media/img/admin/icon_error.gif differ diff --git a/static/admin/media/img/admin/icon_searchbox.png b/static/admin/media/img/admin/icon_searchbox.png new file mode 100644 index 0000000..8ab579e Binary files /dev/null and b/static/admin/media/img/admin/icon_searchbox.png differ diff --git a/static/admin/media/img/admin/icon_success.gif b/static/admin/media/img/admin/icon_success.gif new file mode 100644 index 0000000..5cf90a1 Binary files /dev/null and b/static/admin/media/img/admin/icon_success.gif differ diff --git a/static/admin/media/img/admin/inline-delete-8bit.png b/static/admin/media/img/admin/inline-delete-8bit.png new file mode 100644 index 0000000..95caf59 Binary files /dev/null and b/static/admin/media/img/admin/inline-delete-8bit.png differ diff --git a/static/admin/media/img/admin/inline-delete.png b/static/admin/media/img/admin/inline-delete.png new file mode 100644 index 0000000..d59bcd2 Binary files /dev/null and b/static/admin/media/img/admin/inline-delete.png differ diff --git a/static/admin/media/img/admin/inline-restore-8bit.png b/static/admin/media/img/admin/inline-restore-8bit.png new file mode 100644 index 0000000..e087c8e Binary files /dev/null and b/static/admin/media/img/admin/inline-restore-8bit.png differ diff --git a/static/admin/media/img/admin/inline-restore.png b/static/admin/media/img/admin/inline-restore.png new file mode 100644 index 0000000..efdd92a Binary files /dev/null and b/static/admin/media/img/admin/inline-restore.png differ diff --git a/static/admin/media/img/admin/inline-splitter-bg.gif b/static/admin/media/img/admin/inline-splitter-bg.gif new file mode 100644 index 0000000..32ac5b3 Binary files /dev/null and b/static/admin/media/img/admin/inline-splitter-bg.gif differ diff --git a/static/admin/media/img/admin/nav-bg-grabber.gif b/static/admin/media/img/admin/nav-bg-grabber.gif new file mode 100644 index 0000000..0a784fa Binary files /dev/null and b/static/admin/media/img/admin/nav-bg-grabber.gif differ diff --git a/static/admin/media/img/admin/nav-bg-reverse.gif b/static/admin/media/img/admin/nav-bg-reverse.gif new file mode 100644 index 0000000..f11029f Binary files /dev/null and b/static/admin/media/img/admin/nav-bg-reverse.gif differ diff --git a/static/admin/media/img/admin/nav-bg.gif b/static/admin/media/img/admin/nav-bg.gif new file mode 100644 index 0000000..f8402b8 Binary files /dev/null and b/static/admin/media/img/admin/nav-bg.gif differ diff --git a/static/admin/media/img/admin/selector-add.gif b/static/admin/media/img/admin/selector-add.gif new file mode 100644 index 0000000..50132d1 Binary files /dev/null and b/static/admin/media/img/admin/selector-add.gif differ diff --git a/static/admin/media/img/admin/selector-addall.gif b/static/admin/media/img/admin/selector-addall.gif new file mode 100644 index 0000000..d6e7c63 Binary files /dev/null and b/static/admin/media/img/admin/selector-addall.gif differ diff --git a/static/admin/media/img/admin/selector-remove.gif b/static/admin/media/img/admin/selector-remove.gif new file mode 100644 index 0000000..2b9b0a2 Binary files /dev/null and b/static/admin/media/img/admin/selector-remove.gif differ diff --git a/static/admin/media/img/admin/selector-removeall.gif b/static/admin/media/img/admin/selector-removeall.gif new file mode 100644 index 0000000..5a44219 Binary files /dev/null and b/static/admin/media/img/admin/selector-removeall.gif differ diff --git a/static/admin/media/img/admin/selector-search.gif b/static/admin/media/img/admin/selector-search.gif new file mode 100644 index 0000000..6d5f4c7 Binary files /dev/null and b/static/admin/media/img/admin/selector-search.gif differ diff --git a/static/admin/media/img/admin/selector_stacked-add.gif b/static/admin/media/img/admin/selector_stacked-add.gif new file mode 100644 index 0000000..7426169 Binary files /dev/null and b/static/admin/media/img/admin/selector_stacked-add.gif differ diff --git a/static/admin/media/img/admin/selector_stacked-remove.gif b/static/admin/media/img/admin/selector_stacked-remove.gif new file mode 100644 index 0000000..60412ce Binary files /dev/null and b/static/admin/media/img/admin/selector_stacked-remove.gif differ diff --git a/static/admin/media/img/admin/tool-left.gif b/static/admin/media/img/admin/tool-left.gif new file mode 100644 index 0000000..011490f Binary files /dev/null and b/static/admin/media/img/admin/tool-left.gif differ diff --git a/static/admin/media/img/admin/tool-left_over.gif b/static/admin/media/img/admin/tool-left_over.gif new file mode 100644 index 0000000..937e07b Binary files /dev/null and b/static/admin/media/img/admin/tool-left_over.gif differ diff --git a/static/admin/media/img/admin/tool-right.gif b/static/admin/media/img/admin/tool-right.gif new file mode 100644 index 0000000..cdc140c Binary files /dev/null and b/static/admin/media/img/admin/tool-right.gif differ diff --git a/static/admin/media/img/admin/tool-right_over.gif b/static/admin/media/img/admin/tool-right_over.gif new file mode 100644 index 0000000..4db977e Binary files /dev/null and b/static/admin/media/img/admin/tool-right_over.gif differ diff --git a/static/admin/media/img/admin/tooltag-add.gif b/static/admin/media/img/admin/tooltag-add.gif new file mode 100644 index 0000000..8b53d49 Binary files /dev/null and b/static/admin/media/img/admin/tooltag-add.gif differ diff --git a/static/admin/media/img/admin/tooltag-add_over.gif b/static/admin/media/img/admin/tooltag-add_over.gif new file mode 100644 index 0000000..bfc52f1 Binary files /dev/null and b/static/admin/media/img/admin/tooltag-add_over.gif differ diff --git a/static/admin/media/img/admin/tooltag-arrowright.gif b/static/admin/media/img/admin/tooltag-arrowright.gif new file mode 100644 index 0000000..cdaaae7 Binary files /dev/null and b/static/admin/media/img/admin/tooltag-arrowright.gif differ diff --git a/static/admin/media/img/admin/tooltag-arrowright_over.gif b/static/admin/media/img/admin/tooltag-arrowright_over.gif new file mode 100644 index 0000000..7163189 Binary files /dev/null and b/static/admin/media/img/admin/tooltag-arrowright_over.gif differ diff --git a/static/admin/media/img/gis/move_vertex_off.png b/static/admin/media/img/gis/move_vertex_off.png new file mode 100644 index 0000000..296b2e2 Binary files /dev/null and b/static/admin/media/img/gis/move_vertex_off.png differ diff --git a/static/admin/media/img/gis/move_vertex_on.png b/static/admin/media/img/gis/move_vertex_on.png new file mode 100644 index 0000000..21f4758 Binary files /dev/null and b/static/admin/media/img/gis/move_vertex_on.png differ diff --git a/static/admin/media/js/SelectBox.js b/static/admin/media/js/SelectBox.js new file mode 100644 index 0000000..f28c861 --- /dev/null +++ b/static/admin/media/js/SelectBox.js @@ -0,0 +1,111 @@ +var SelectBox = { + cache: new Object(), + init: function(id) { + var box = document.getElementById(id); + var node; + SelectBox.cache[id] = new Array(); + var cache = SelectBox.cache[id]; + for (var i = 0; (node = box.options[i]); i++) { + cache.push({value: node.value, text: node.text, displayed: 1}); + } + }, + redisplay: function(id) { + // Repopulate HTML select box from cache + var box = document.getElementById(id); + box.options.length = 0; // clear all options + for (var i = 0, j = SelectBox.cache[id].length; i < j; i++) { + var node = SelectBox.cache[id][i]; + if (node.displayed) { + box.options[box.options.length] = new Option(node.text, node.value, false, false); + } + } + }, + filter: function(id, text) { + // Redisplay the HTML select box, displaying only the choices containing ALL + // the words in text. (It's an AND search.) + var tokens = text.toLowerCase().split(/\s+/); + var node, token; + for (var i = 0; (node = SelectBox.cache[id][i]); i++) { + node.displayed = 1; + for (var j = 0; (token = tokens[j]); j++) { + if (node.text.toLowerCase().indexOf(token) == -1) { + node.displayed = 0; + } + } + } + SelectBox.redisplay(id); + }, + delete_from_cache: function(id, value) { + var node, delete_index = null; + for (var i = 0; (node = SelectBox.cache[id][i]); i++) { + if (node.value == value) { + delete_index = i; + break; + } + } + var j = SelectBox.cache[id].length - 1; + for (var i = delete_index; i < j; i++) { + SelectBox.cache[id][i] = SelectBox.cache[id][i+1]; + } + SelectBox.cache[id].length--; + }, + add_to_cache: function(id, option) { + SelectBox.cache[id].push({value: option.value, text: option.text, displayed: 1}); + }, + cache_contains: function(id, value) { + // Check if an item is contained in the cache + var node; + for (var i = 0; (node = SelectBox.cache[id][i]); i++) { + if (node.value == value) { + return true; + } + } + return false; + }, + move: function(from, to) { + var from_box = document.getElementById(from); + var to_box = document.getElementById(to); + var option; + for (var i = 0; (option = from_box.options[i]); i++) { + if (option.selected && SelectBox.cache_contains(from, option.value)) { + SelectBox.add_to_cache(to, {value: option.value, text: option.text, displayed: 1}); + SelectBox.delete_from_cache(from, option.value); + } + } + SelectBox.redisplay(from); + SelectBox.redisplay(to); + }, + move_all: function(from, to) { + var from_box = document.getElementById(from); + var to_box = document.getElementById(to); + var option; + for (var i = 0; (option = from_box.options[i]); i++) { + if (SelectBox.cache_contains(from, option.value)) { + SelectBox.add_to_cache(to, {value: option.value, text: option.text, displayed: 1}); + SelectBox.delete_from_cache(from, option.value); + } + } + SelectBox.redisplay(from); + SelectBox.redisplay(to); + }, + sort: function(id) { + SelectBox.cache[id].sort( function(a, b) { + a = a.text.toLowerCase(); + b = b.text.toLowerCase(); + try { + if (a > b) return 1; + if (a < b) return -1; + } + catch (e) { + // silently fail on IE 'unknown' exception + } + return 0; + } ); + }, + select_all: function(id) { + var box = document.getElementById(id); + for (var i = 0; i < box.options.length; i++) { + box.options[i].selected = 'selected'; + } + } +} diff --git a/static/admin/media/js/SelectFilter2.js b/static/admin/media/js/SelectFilter2.js new file mode 100644 index 0000000..db946a6 --- /dev/null +++ b/static/admin/media/js/SelectFilter2.js @@ -0,0 +1,113 @@ +/* +SelectFilter2 - Turns a multiple-select box into a filter interface. + +Different than SelectFilter because this is coupled to the admin framework. + +Requires core.js, SelectBox.js and addevent.js. +*/ + +function findForm(node) { + // returns the node of the form containing the given node + if (node.tagName.toLowerCase() != 'form') { + return findForm(node.parentNode); + } + return node; +} + +var SelectFilter = { + init: function(field_id, field_name, is_stacked, admin_media_prefix) { + var from_box = document.getElementById(field_id); + from_box.id += '_from'; // change its ID + from_box.className = 'filtered'; + + // Remove <p class="info">, because it just gets in the way. + var ps = from_box.parentNode.getElementsByTagName('p'); + for (var i=0; i<ps.length; i++) { + from_box.parentNode.removeChild(ps[i]); + } + + // <div class="selector"> or <div class="selector stacked"> + var selector_div = quickElement('div', from_box.parentNode); + selector_div.className = is_stacked ? 'selector stacked' : 'selector'; + + // <div class="selector-available"> + var selector_available = quickElement('div', selector_div, ''); + selector_available.className = 'selector-available'; + quickElement('h2', selector_available, interpolate(gettext('Available %s'), [field_name])); + var filter_p = quickElement('p', selector_available, ''); + filter_p.className = 'selector-filter'; + quickElement('img', filter_p, '', 'src', admin_media_prefix + 'img/admin/selector-search.gif'); + filter_p.appendChild(document.createTextNode(' ')); + var filter_input = quickElement('input', filter_p, '', 'type', 'text'); + filter_input.id = field_id + '_input'; + selector_available.appendChild(from_box); + var choose_all = quickElement('a', selector_available, gettext('Choose all'), 'href', 'javascript: (function(){ SelectBox.move_all("' + field_id + '_from", "' + field_id + '_to"); })()'); + choose_all.className = 'selector-chooseall'; + + // <ul class="selector-chooser"> + var selector_chooser = quickElement('ul', selector_div, ''); + selector_chooser.className = 'selector-chooser'; + var add_link = quickElement('a', quickElement('li', selector_chooser, ''), gettext('Add'), 'href', 'javascript: (function(){ SelectBox.move("' + field_id + '_from","' + field_id + '_to");})()'); + add_link.className = 'selector-add'; + var remove_link = quickElement('a', quickElement('li', selector_chooser, ''), gettext('Remove'), 'href', 'javascript: (function(){ SelectBox.move("' + field_id + '_to","' + field_id + '_from");})()'); + remove_link.className = 'selector-remove'; + + // <div class="selector-chosen"> + var selector_chosen = quickElement('div', selector_div, ''); + selector_chosen.className = 'selector-chosen'; + quickElement('h2', selector_chosen, interpolate(gettext('Chosen %s'), [field_name])); + var selector_filter = quickElement('p', selector_chosen, gettext('Select your choice(s) and click ')); + selector_filter.className = 'selector-filter'; + quickElement('img', selector_filter, '', 'src', admin_media_prefix + (is_stacked ? 'img/admin/selector_stacked-add.gif':'img/admin/selector-add.gif'), 'alt', 'Add'); + var to_box = quickElement('select', selector_chosen, '', 'id', field_id + '_to', 'multiple', 'multiple', 'size', from_box.size, 'name', from_box.getAttribute('name')); + to_box.className = 'filtered'; + var clear_all = quickElement('a', selector_chosen, gettext('Clear all'), 'href', 'javascript: (function() { SelectBox.move_all("' + field_id + '_to", "' + field_id + '_from");})()'); + clear_all.className = 'selector-clearall'; + + from_box.setAttribute('name', from_box.getAttribute('name') + '_old'); + + // Set up the JavaScript event handlers for the select box filter interface + addEvent(filter_input, 'keyup', function(e) { SelectFilter.filter_key_up(e, field_id); }); + addEvent(filter_input, 'keydown', function(e) { SelectFilter.filter_key_down(e, field_id); }); + addEvent(from_box, 'dblclick', function() { SelectBox.move(field_id + '_from', field_id + '_to'); }); + addEvent(to_box, 'dblclick', function() { SelectBox.move(field_id + '_to', field_id + '_from'); }); + addEvent(findForm(from_box), 'submit', function() { SelectBox.select_all(field_id + '_to'); }); + SelectBox.init(field_id + '_from'); + SelectBox.init(field_id + '_to'); + // Move selected from_box options to to_box + SelectBox.move(field_id + '_from', field_id + '_to'); + }, + filter_key_up: function(event, field_id) { + from = document.getElementById(field_id + '_from'); + // don't submit form if user pressed Enter + if ((event.which && event.which == 13) || (event.keyCode && event.keyCode == 13)) { + from.selectedIndex = 0; + SelectBox.move(field_id + '_from', field_id + '_to'); + from.selectedIndex = 0; + return false; + } + var temp = from.selectedIndex; + SelectBox.filter(field_id + '_from', document.getElementById(field_id + '_input').value); + from.selectedIndex = temp; + return true; + }, + filter_key_down: function(event, field_id) { + from = document.getElementById(field_id + '_from'); + // right arrow -- move across + if ((event.which && event.which == 39) || (event.keyCode && event.keyCode == 39)) { + var old_index = from.selectedIndex; + SelectBox.move(field_id + '_from', field_id + '_to'); + from.selectedIndex = (old_index == from.length) ? from.length - 1 : old_index; + return false; + } + // down arrow -- wrap around + if ((event.which && event.which == 40) || (event.keyCode && event.keyCode == 40)) { + from.selectedIndex = (from.length == from.selectedIndex + 1) ? 0 : from.selectedIndex + 1; + } + // up arrow -- wrap around + if ((event.which && event.which == 38) || (event.keyCode && event.keyCode == 38)) { + from.selectedIndex = (from.selectedIndex == 0) ? from.length - 1 : from.selectedIndex - 1; + } + return true; + } +} diff --git a/static/admin/media/js/actions.js b/static/admin/media/js/actions.js new file mode 100644 index 0000000..d34488a --- /dev/null +++ b/static/admin/media/js/actions.js @@ -0,0 +1,39 @@ +var Actions = { + init: function() { + var selectAll = document.getElementById('action-toggle'); + if (selectAll) { + selectAll.style.display = 'inline'; + addEvent(selectAll, 'click', function() { + Actions.checker(selectAll.checked); + }); + } + var changelistTable = document.getElementsBySelector('#changelist table')[0]; + if (changelistTable) { + addEvent(changelistTable, 'click', function(e) { + if (!e) { var e = window.event; } + var target = e.target ? e.target : e.srcElement; + if (target.nodeType == 3) { target = target.parentNode; } + if (target.className == 'action-select') { + var tr = target.parentNode.parentNode; + Actions.toggleRow(tr, target.checked); + } + }); + } + }, + toggleRow: function(tr, checked) { + if (checked && tr.className.indexOf('selected') == -1) { + tr.className += ' selected'; + } else if (!checked) { + tr.className = tr.className.replace(' selected', ''); + } + }, + checker: function(checked) { + var actionCheckboxes = document.getElementsBySelector('tr input.action-select'); + for(var i = 0; i < actionCheckboxes.length; i++) { + actionCheckboxes[i].checked = checked; + Actions.toggleRow(actionCheckboxes[i].parentNode.parentNode, checked); + } + } +}; + +addEvent(window, 'load', Actions.init); diff --git a/static/admin/media/js/admin/CollapsedFieldsets.js b/static/admin/media/js/admin/CollapsedFieldsets.js new file mode 100644 index 0000000..d66bec0 --- /dev/null +++ b/static/admin/media/js/admin/CollapsedFieldsets.js @@ -0,0 +1,85 @@ +// Finds all fieldsets with class="collapse", collapses them, and gives each +// one a "Show" link that uncollapses it. The "Show" link becomes a "Hide" +// link when the fieldset is visible. + +function findForm(node) { + // returns the node of the form containing the given node + if (node.tagName.toLowerCase() != 'form') { + return findForm(node.parentNode); + } + return node; +} + +var CollapsedFieldsets = { + collapse_re: /\bcollapse\b/, // Class of fieldsets that should be dealt with. + collapsed_re: /\bcollapsed\b/, // Class that fieldsets get when they're hidden. + collapsed_class: 'collapsed', + init: function() { + var fieldsets = document.getElementsByTagName('fieldset'); + var collapsed_seen = false; + for (var i = 0, fs; fs = fieldsets[i]; i++) { + // Collapse this fieldset if it has the correct class, and if it + // doesn't have any errors. (Collapsing shouldn't apply in the case + // of error messages.) + if (fs.className.match(CollapsedFieldsets.collapse_re) && !CollapsedFieldsets.fieldset_has_errors(fs)) { + collapsed_seen = true; + // Give it an additional class, used by CSS to hide it. + fs.className += ' ' + CollapsedFieldsets.collapsed_class; + // (<a id="fieldsetcollapser3" class="collapse-toggle" href="#">Show</a>) + var collapse_link = document.createElement('a'); + collapse_link.className = 'collapse-toggle'; + collapse_link.id = 'fieldsetcollapser' + i; + collapse_link.onclick = new Function('CollapsedFieldsets.show('+i+'); return false;'); + collapse_link.href = '#'; + collapse_link.innerHTML = gettext('Show'); + var h2 = fs.getElementsByTagName('h2')[0]; + h2.appendChild(document.createTextNode(' (')); + h2.appendChild(collapse_link); + h2.appendChild(document.createTextNode(')')); + } + } + if (collapsed_seen) { + // Expand all collapsed fieldsets when form is submitted. + addEvent(findForm(document.getElementsByTagName('fieldset')[0]), 'submit', function() { CollapsedFieldsets.uncollapse_all(); }); + } + }, + fieldset_has_errors: function(fs) { + // Returns true if any fields in the fieldset have validation errors. + var divs = fs.getElementsByTagName('div'); + for (var i=0; i<divs.length; i++) { + if (divs[i].className.match(/\berrors\b/)) { + return true; + } + } + return false; + }, + show: function(fieldset_index) { + var fs = document.getElementsByTagName('fieldset')[fieldset_index]; + // Remove the class name that causes the "display: none". + fs.className = fs.className.replace(CollapsedFieldsets.collapsed_re, ''); + // Toggle the "Show" link to a "Hide" link + var collapse_link = document.getElementById('fieldsetcollapser' + fieldset_index); + collapse_link.onclick = new Function('CollapsedFieldsets.hide('+fieldset_index+'); return false;'); + collapse_link.innerHTML = gettext('Hide'); + }, + hide: function(fieldset_index) { + var fs = document.getElementsByTagName('fieldset')[fieldset_index]; + // Add the class name that causes the "display: none". + fs.className += ' ' + CollapsedFieldsets.collapsed_class; + // Toggle the "Hide" link to a "Show" link + var collapse_link = document.getElementById('fieldsetcollapser' + fieldset_index); + collapse_link.onclick = new Function('CollapsedFieldsets.show('+fieldset_index+'); return false;'); + collapse_link.innerHTML = gettext('Show'); + }, + + uncollapse_all: function() { + var fieldsets = document.getElementsByTagName('fieldset'); + for (var i=0; i<fieldsets.length; i++) { + if (fieldsets[i].className.match(CollapsedFieldsets.collapsed_re)) { + CollapsedFieldsets.show(i); + } + } + } +} + +addEvent(window, 'load', CollapsedFieldsets.init); diff --git a/static/admin/media/js/admin/DateTimeShortcuts.js b/static/admin/media/js/admin/DateTimeShortcuts.js new file mode 100644 index 0000000..e3ebd03 --- /dev/null +++ b/static/admin/media/js/admin/DateTimeShortcuts.js @@ -0,0 +1,255 @@ +// Inserts shortcut buttons after all of the following: +// <input type="text" class="vDateField"> +// <input type="text" class="vTimeField"> + +var DateTimeShortcuts = { + calendars: [], + calendarInputs: [], + clockInputs: [], + calendarDivName1: 'calendarbox', // name of calendar <div> that gets toggled + calendarDivName2: 'calendarin', // name of <div> that contains calendar + calendarLinkName: 'calendarlink',// name of the link that is used to toggle + clockDivName: 'clockbox', // name of clock <div> that gets toggled + clockLinkName: 'clocklink', // name of the link that is used to toggle + admin_media_prefix: '', + init: function() { + // Deduce admin_media_prefix by looking at the <script>s in the + // current document and finding the URL of *this* module. + var scripts = document.getElementsByTagName('script'); + for (var i=0; i<scripts.length; i++) { + if (scripts[i].src.match(/DateTimeShortcuts/)) { + var idx = scripts[i].src.indexOf('js/admin/DateTimeShortcuts'); + DateTimeShortcuts.admin_media_prefix = scripts[i].src.substring(0, idx); + break; + } + } + + var inputs = document.getElementsByTagName('input'); + for (i=0; i<inputs.length; i++) { + var inp = inputs[i]; + if (inp.getAttribute('type') == 'text' && inp.className.match(/vTimeField/)) { + DateTimeShortcuts.addClock(inp); + } + else if (inp.getAttribute('type') == 'text' && inp.className.match(/vDateField/)) { + DateTimeShortcuts.addCalendar(inp); + } + } + }, + // Add clock widget to a given field + addClock: function(inp) { + var num = DateTimeShortcuts.clockInputs.length; + DateTimeShortcuts.clockInputs[num] = inp; + + // Shortcut links (clock icon and "Now" link) + var shortcuts_span = document.createElement('span'); + inp.parentNode.insertBefore(shortcuts_span, inp.nextSibling); + var now_link = document.createElement('a'); + now_link.setAttribute('href', "javascript:DateTimeShortcuts.handleClockQuicklink(" + num + ", new Date().getHourMinuteSecond());"); + now_link.appendChild(document.createTextNode(gettext('Now'))); + var clock_link = document.createElement('a'); + clock_link.setAttribute('href', 'javascript:DateTimeShortcuts.openClock(' + num + ');'); + clock_link.id = DateTimeShortcuts.clockLinkName + num; + quickElement('img', clock_link, '', 'src', DateTimeShortcuts.admin_media_prefix + 'img/admin/icon_clock.gif', 'alt', gettext('Clock')); + shortcuts_span.appendChild(document.createTextNode('\240')); + shortcuts_span.appendChild(now_link); + shortcuts_span.appendChild(document.createTextNode('\240|\240')); + shortcuts_span.appendChild(clock_link); + + // Create clock link div + // + // Markup looks like: + // <div id="clockbox1" class="clockbox module"> + // <h2>Choose a time</h2> + // <ul class="timelist"> + // <li><a href="#">Now</a></li> + // <li><a href="#">Midnight</a></li> + // <li><a href="#">6 a.m.</a></li> + // <li><a href="#">Noon</a></li> + // </ul> + // <p class="calendar-cancel"><a href="#">Cancel</a></p> + // </div> + + var clock_box = document.createElement('div'); + clock_box.style.display = 'none'; + clock_box.style.position = 'absolute'; + clock_box.className = 'clockbox module'; + clock_box.setAttribute('id', DateTimeShortcuts.clockDivName + num); + document.body.appendChild(clock_box); + addEvent(clock_box, 'click', DateTimeShortcuts.cancelEventPropagation); + + quickElement('h2', clock_box, gettext('Choose a time')); + time_list = quickElement('ul', clock_box, ''); + time_list.className = 'timelist'; + quickElement("a", quickElement("li", time_list, ""), gettext("Now"), "href", "javascript:DateTimeShortcuts.handleClockQuicklink(" + num + ", new Date().getHourMinuteSecond());") + quickElement("a", quickElement("li", time_list, ""), gettext("Midnight"), "href", "javascript:DateTimeShortcuts.handleClockQuicklink(" + num + ", '00:00:00');") + quickElement("a", quickElement("li", time_list, ""), gettext("6 a.m."), "href", "javascript:DateTimeShortcuts.handleClockQuicklink(" + num + ", '06:00:00');") + quickElement("a", quickElement("li", time_list, ""), gettext("Noon"), "href", "javascript:DateTimeShortcuts.handleClockQuicklink(" + num + ", '12:00:00');") + + cancel_p = quickElement('p', clock_box, ''); + cancel_p.className = 'calendar-cancel'; + quickElement('a', cancel_p, gettext('Cancel'), 'href', 'javascript:DateTimeShortcuts.dismissClock(' + num + ');'); + }, + openClock: function(num) { + var clock_box = document.getElementById(DateTimeShortcuts.clockDivName+num) + var clock_link = document.getElementById(DateTimeShortcuts.clockLinkName+num) + + // Recalculate the clockbox position + // is it left-to-right or right-to-left layout ? + if (getStyle(document.body,'direction')!='rtl') { + clock_box.style.left = findPosX(clock_link) + 17 + 'px'; + } + else { + // since style's width is in em, it'd be tough to calculate + // px value of it. let's use an estimated px for now + // TODO: IE returns wrong value for findPosX when in rtl mode + // (it returns as it was left aligned), needs to be fixed. + clock_box.style.left = findPosX(clock_link) - 110 + 'px'; + } + clock_box.style.top = findPosY(clock_link) - 30 + 'px'; + + // Show the clock box + clock_box.style.display = 'block'; + addEvent(window.document, 'click', function() { DateTimeShortcuts.dismissClock(num); return true; }); + }, + dismissClock: function(num) { + document.getElementById(DateTimeShortcuts.clockDivName + num).style.display = 'none'; + window.document.onclick = null; + }, + handleClockQuicklink: function(num, val) { + DateTimeShortcuts.clockInputs[num].value = val; + DateTimeShortcuts.dismissClock(num); + }, + // Add calendar widget to a given field. + addCalendar: function(inp) { + var num = DateTimeShortcuts.calendars.length; + + DateTimeShortcuts.calendarInputs[num] = inp; + + // Shortcut links (calendar icon and "Today" link) + var shortcuts_span = document.createElement('span'); + inp.parentNode.insertBefore(shortcuts_span, inp.nextSibling); + var today_link = document.createElement('a'); + today_link.setAttribute('href', 'javascript:DateTimeShortcuts.handleCalendarQuickLink(' + num + ', 0);'); + today_link.appendChild(document.createTextNode(gettext('Today'))); + var cal_link = document.createElement('a'); + cal_link.setAttribute('href', 'javascript:DateTimeShortcuts.openCalendar(' + num + ');'); + cal_link.id = DateTimeShortcuts.calendarLinkName + num; + quickElement('img', cal_link, '', 'src', DateTimeShortcuts.admin_media_prefix + 'img/admin/icon_calendar.gif', 'alt', gettext('Calendar')); + shortcuts_span.appendChild(document.createTextNode('\240')); + shortcuts_span.appendChild(today_link); + shortcuts_span.appendChild(document.createTextNode('\240|\240')); + shortcuts_span.appendChild(cal_link); + + // Create calendarbox div. + // + // Markup looks like: + // + // <div id="calendarbox3" class="calendarbox module"> + // <h2> + // <a href="#" class="link-previous">&lsaquo;</a> + // <a href="#" class="link-next">&rsaquo;</a> February 2003 + // </h2> + // <div class="calendar" id="calendarin3"> + // <!-- (cal) --> + // </div> + // <div class="calendar-shortcuts"> + // <a href="#">Yesterday</a> | <a href="#">Today</a> | <a href="#">Tomorrow</a> + // </div> + // <p class="calendar-cancel"><a href="#">Cancel</a></p> + // </div> + var cal_box = document.createElement('div'); + cal_box.style.display = 'none'; + cal_box.style.position = 'absolute'; + cal_box.className = 'calendarbox module'; + cal_box.setAttribute('id', DateTimeShortcuts.calendarDivName1 + num); + document.body.appendChild(cal_box); + addEvent(cal_box, 'click', DateTimeShortcuts.cancelEventPropagation); + + // next-prev links + var cal_nav = quickElement('div', cal_box, ''); + var cal_nav_prev = quickElement('a', cal_nav, '<', 'href', 'javascript:DateTimeShortcuts.drawPrev('+num+');'); + cal_nav_prev.className = 'calendarnav-previous'; + var cal_nav_next = quickElement('a', cal_nav, '>', 'href', 'javascript:DateTimeShortcuts.drawNext('+num+');'); + cal_nav_next.className = 'calendarnav-next'; + + // main box + var cal_main = quickElement('div', cal_box, '', 'id', DateTimeShortcuts.calendarDivName2 + num); + cal_main.className = 'calendar'; + DateTimeShortcuts.calendars[num] = new Calendar(DateTimeShortcuts.calendarDivName2 + num, DateTimeShortcuts.handleCalendarCallback(num)); + DateTimeShortcuts.calendars[num].drawCurrent(); + + // calendar shortcuts + var shortcuts = quickElement('div', cal_box, ''); + shortcuts.className = 'calendar-shortcuts'; + quickElement('a', shortcuts, gettext('Yesterday'), 'href', 'javascript:DateTimeShortcuts.handleCalendarQuickLink(' + num + ', -1);'); + shortcuts.appendChild(document.createTextNode('\240|\240')); + quickElement('a', shortcuts, gettext('Today'), 'href', 'javascript:DateTimeShortcuts.handleCalendarQuickLink(' + num + ', 0);'); + shortcuts.appendChild(document.createTextNode('\240|\240')); + quickElement('a', shortcuts, gettext('Tomorrow'), 'href', 'javascript:DateTimeShortcuts.handleCalendarQuickLink(' + num + ', +1);'); + + // cancel bar + var cancel_p = quickElement('p', cal_box, ''); + cancel_p.className = 'calendar-cancel'; + quickElement('a', cancel_p, gettext('Cancel'), 'href', 'javascript:DateTimeShortcuts.dismissCalendar(' + num + ');'); + }, + openCalendar: function(num) { + var cal_box = document.getElementById(DateTimeShortcuts.calendarDivName1+num) + var cal_link = document.getElementById(DateTimeShortcuts.calendarLinkName+num) + var inp = DateTimeShortcuts.calendarInputs[num]; + + // Determine if the current value in the input has a valid date. + // If so, draw the calendar with that date's year and month. + if (inp.value) { + var date_parts = inp.value.split('-'); + var year = date_parts[0]; + var month = parseFloat(date_parts[1]); + if (year.match(/\d\d\d\d/) && month >= 1 && month <= 12) { + DateTimeShortcuts.calendars[num].drawDate(month, year); + } + } + + + // Recalculate the clockbox position + // is it left-to-right or right-to-left layout ? + if (getStyle(document.body,'direction')!='rtl') { + cal_box.style.left = findPosX(cal_link) + 17 + 'px'; + } + else { + // since style's width is in em, it'd be tough to calculate + // px value of it. let's use an estimated px for now + // TODO: IE returns wrong value for findPosX when in rtl mode + // (it returns as it was left aligned), needs to be fixed. + cal_box.style.left = findPosX(cal_link) - 180 + 'px'; + } + cal_box.style.top = findPosY(cal_link) - 75 + 'px'; + + cal_box.style.display = 'block'; + addEvent(window.document, 'click', function() { DateTimeShortcuts.dismissCalendar(num); return true; }); + }, + dismissCalendar: function(num) { + document.getElementById(DateTimeShortcuts.calendarDivName1+num).style.display = 'none'; + window.document.onclick = null; + }, + drawPrev: function(num) { + DateTimeShortcuts.calendars[num].drawPreviousMonth(); + }, + drawNext: function(num) { + DateTimeShortcuts.calendars[num].drawNextMonth(); + }, + handleCalendarCallback: function(num) { + return "function(y, m, d) { DateTimeShortcuts.calendarInputs["+num+"].value = y+'-'+(m<10?'0':'')+m+'-'+(d<10?'0':'')+d; document.getElementById(DateTimeShortcuts.calendarDivName1+"+num+").style.display='none';}"; + }, + handleCalendarQuickLink: function(num, offset) { + var d = new Date(); + d.setDate(d.getDate() + offset) + DateTimeShortcuts.calendarInputs[num].value = d.getISODate(); + DateTimeShortcuts.dismissCalendar(num); + }, + cancelEventPropagation: function(e) { + if (!e) e = window.event; + e.cancelBubble = true; + if (e.stopPropagation) e.stopPropagation(); + } +} + +addEvent(window, 'load', DateTimeShortcuts.init); diff --git a/static/admin/media/js/admin/RelatedObjectLookups.js b/static/admin/media/js/admin/RelatedObjectLookups.js new file mode 100644 index 0000000..1bc78f8 --- /dev/null +++ b/static/admin/media/js/admin/RelatedObjectLookups.js @@ -0,0 +1,96 @@ +// Handles related-objects functionality: lookup link for raw_id_fields +// and Add Another links. + +function html_unescape(text) { + // Unescape a string that was escaped using django.utils.html.escape. + text = text.replace(/&lt;/g, '<'); + text = text.replace(/&gt;/g, '>'); + text = text.replace(/&quot;/g, '"'); + text = text.replace(/&#39;/g, "'"); + text = text.replace(/&amp;/g, '&'); + return text; +} + +// IE doesn't accept periods or dashes in the window name, but the element IDs +// we use to generate popup window names may contain them, therefore we map them +// to allowed characters in a reversible way so that we can locate the correct +// element when the popup window is dismissed. +function id_to_windowname(text) { + text = text.replace(/\./g, '__dot__'); + text = text.replace(/\-/g, '__dash__'); + return text; +} + +function windowname_to_id(text) { + text = text.replace(/__dot__/g, '.'); + text = text.replace(/__dash__/g, '-'); + return text; +} + +function showRelatedObjectLookupPopup(triggeringLink) { + var name = triggeringLink.id.replace(/^lookup_/, ''); + name = id_to_windowname(name); + var href; + if (triggeringLink.href.search(/\?/) >= 0) { + href = triggeringLink.href + '&pop=1'; + } else { + href = triggeringLink.href + '?pop=1'; + } + var win = window.open(href, name, 'height=500,width=800,resizable=yes,scrollbars=yes'); + win.focus(); + return false; +} + +function dismissRelatedLookupPopup(win, chosenId) { + var name = windowname_to_id(win.name); + var elem = document.getElementById(name); + if (elem.className.indexOf('vManyToManyRawIdAdminField') != -1 && elem.value) { + elem.value += ',' + chosenId; + } else { + document.getElementById(name).value = chosenId; + } + win.close(); +} + +function showAddAnotherPopup(triggeringLink) { + var name = triggeringLink.id.replace(/^add_/, ''); + name = id_to_windowname(name); + href = triggeringLink.href + if (href.indexOf('?') == -1) { + href += '?_popup=1'; + } else { + href += '&_popup=1'; + } + var win = window.open(href, name, 'height=500,width=800,resizable=yes,scrollbars=yes'); + win.focus(); + return false; +} + +function dismissAddAnotherPopup(win, newId, newRepr) { + // newId and newRepr are expected to have previously been escaped by + // django.utils.html.escape. + newId = html_unescape(newId); + newRepr = html_unescape(newRepr); + var name = windowname_to_id(win.name); + var elem = document.getElementById(name); + if (elem) { + if (elem.nodeName == 'SELECT') { + var o = new Option(newRepr, newId); + elem.options[elem.options.length] = o; + o.selected = true; + } else if (elem.nodeName == 'INPUT') { + if (elem.className.indexOf('vManyToManyRawIdAdminField') != -1 && elem.value) { + elem.value += ',' + newId; + } else { + elem.value = newId; + } + } + } else { + var toId = name + "_to"; + elem = document.getElementById(toId); + var o = new Option(newRepr, newId); + SelectBox.add_to_cache(toId, o); + SelectBox.redisplay(toId); + } + win.close(); +} diff --git a/static/admin/media/js/admin/ordering.js b/static/admin/media/js/admin/ordering.js new file mode 100644 index 0000000..53c42f3 --- /dev/null +++ b/static/admin/media/js/admin/ordering.js @@ -0,0 +1,137 @@ +addEvent(window, 'load', reorder_init); + +var lis; +var top = 0; +var left = 0; +var height = 30; + +function reorder_init() { + lis = document.getElementsBySelector('ul#orderthese li'); + var input = document.getElementsBySelector('input[name=order_]')[0]; + setOrder(input.value.split(',')); + input.disabled = true; + draw(); + // Now initialise the dragging behaviour + var limit = (lis.length - 1) * height; + for (var i = 0; i < lis.length; i++) { + var li = lis[i]; + var img = document.getElementById('handle'+li.id); + li.style.zIndex = 1; + Drag.init(img, li, left + 10, left + 10, top + 10, top + 10 + limit); + li.onDragStart = startDrag; + li.onDragEnd = endDrag; + img.style.cursor = 'move'; + } +} + +function submitOrderForm() { + var inputOrder = document.getElementsBySelector('input[name=order_]')[0]; + inputOrder.value = getOrder(); + inputOrder.disabled=false; +} + +function startDrag() { + this.style.zIndex = '10'; + this.className = 'dragging'; +} + +function endDrag(x, y) { + this.style.zIndex = '1'; + this.className = ''; + // Work out how far along it has been dropped, using x co-ordinate + var oldIndex = this.index; + var newIndex = Math.round((y - 10 - top) / height); + // 'Snap' to the correct position + this.style.top = (10 + top + newIndex * height) + 'px'; + this.index = newIndex; + moveItem(oldIndex, newIndex); +} + +function moveItem(oldIndex, newIndex) { + // Swaps two items, adjusts the index and left co-ord for all others + if (oldIndex == newIndex) { + return; // Nothing to swap; + } + var direction, lo, hi; + if (newIndex > oldIndex) { + lo = oldIndex; + hi = newIndex; + direction = -1; + } else { + direction = 1; + hi = oldIndex; + lo = newIndex; + } + var lis2 = new Array(); // We will build the new order in this array + for (var i = 0; i < lis.length; i++) { + if (i < lo || i > hi) { + // Position of items not between the indexes is unaffected + lis2[i] = lis[i]; + continue; + } else if (i == newIndex) { + lis2[i] = lis[oldIndex]; + continue; + } else { + // Item is between the two indexes - move it along 1 + lis2[i] = lis[i - direction]; + } + } + // Re-index everything + reIndex(lis2); + lis = lis2; + draw(); +// document.getElementById('hiddenOrder').value = getOrder(); + document.getElementsBySelector('input[name=order_]')[0].value = getOrder(); +} + +function reIndex(lis) { + for (var i = 0; i < lis.length; i++) { + lis[i].index = i; + } +} + +function draw() { + for (var i = 0; i < lis.length; i++) { + var li = lis[i]; + li.index = i; + li.style.position = 'absolute'; + li.style.left = (10 + left) + 'px'; + li.style.top = (10 + top + (i * height)) + 'px'; + } +} + +function getOrder() { + var order = new Array(lis.length); + for (var i = 0; i < lis.length; i++) { + order[i] = lis[i].id.substring(1, 100); + } + return order.join(','); +} + +function setOrder(id_list) { + /* Set the current order to match the lsit of IDs */ + var temp_lis = new Array(); + for (var i = 0; i < id_list.length; i++) { + var id = 'p' + id_list[i]; + temp_lis[temp_lis.length] = document.getElementById(id); + } + reIndex(temp_lis); + lis = temp_lis; + draw(); +} + +function addEvent(elm, evType, fn, useCapture) +// addEvent and removeEvent +// cross-browser event handling for IE5+, NS6 and Mozilla +// By Scott Andrew +{ + if (elm.addEventListener){ + elm.addEventListener(evType, fn, useCapture); + return true; + } else if (elm.attachEvent){ + var r = elm.attachEvent("on"+evType, fn); + return r; + } else { + elm['on'+evType] = fn; + } +} diff --git a/static/admin/media/js/calendar.js b/static/admin/media/js/calendar.js new file mode 100644 index 0000000..9035176 --- /dev/null +++ b/static/admin/media/js/calendar.js @@ -0,0 +1,143 @@ +/* +calendar.js - Calendar functions by Adrian Holovaty +*/ + +function removeChildren(a) { // "a" is reference to an object + while (a.hasChildNodes()) a.removeChild(a.lastChild); +} + +// quickElement(tagType, parentReference, textInChildNode, [, attribute, attributeValue ...]); +function quickElement() { + var obj = document.createElement(arguments[0]); + if (arguments[2] != '' && arguments[2] != null) { + var textNode = document.createTextNode(arguments[2]); + obj.appendChild(textNode); + } + var len = arguments.length; + for (var i = 3; i < len; i += 2) { + obj.setAttribute(arguments[i], arguments[i+1]); + } + arguments[1].appendChild(obj); + return obj; +} + +// CalendarNamespace -- Provides a collection of HTML calendar-related helper functions +var CalendarNamespace = { + monthsOfYear: gettext('January February March April May June July August September October November December').split(' '), + daysOfWeek: gettext('S M T W T F S').split(' '), + isLeapYear: function(year) { + return (((year % 4)==0) && ((year % 100)!=0) || ((year % 400)==0)); + }, + getDaysInMonth: function(month,year) { + var days; + if (month==1 || month==3 || month==5 || month==7 || month==8 || month==10 || month==12) { + days = 31; + } + else if (month==4 || month==6 || month==9 || month==11) { + days = 30; + } + else if (month==2 && CalendarNamespace.isLeapYear(year)) { + days = 29; + } + else { + days = 28; + } + return days; + }, + draw: function(month, year, div_id, callback) { // month = 1-12, year = 1-9999 + month = parseInt(month); + year = parseInt(year); + var calDiv = document.getElementById(div_id); + removeChildren(calDiv); + var calTable = document.createElement('table'); + quickElement('caption', calTable, CalendarNamespace.monthsOfYear[month-1] + ' ' + year); + var tableBody = quickElement('tbody', calTable); + + // Draw days-of-week header + var tableRow = quickElement('tr', tableBody); + for (var i = 0; i < 7; i++) { + quickElement('th', tableRow, CalendarNamespace.daysOfWeek[i]); + } + + var startingPos = new Date(year, month-1, 1).getDay(); + var days = CalendarNamespace.getDaysInMonth(month, year); + + // Draw blanks before first of month + tableRow = quickElement('tr', tableBody); + for (var i = 0; i < startingPos; i++) { + var _cell = quickElement('td', tableRow, ' '); + _cell.style.backgroundColor = '#f3f3f3'; + } + + // Draw days of month + var currentDay = 1; + for (var i = startingPos; currentDay <= days; i++) { + if (i%7 == 0 && currentDay != 1) { + tableRow = quickElement('tr', tableBody); + } + var cell = quickElement('td', tableRow, ''); + quickElement('a', cell, currentDay, 'href', 'javascript:void(' + callback + '('+year+','+month+','+currentDay+'));'); + currentDay++; + } + + // Draw blanks after end of month (optional, but makes for valid code) + while (tableRow.childNodes.length < 7) { + var _cell = quickElement('td', tableRow, ' '); + _cell.style.backgroundColor = '#f3f3f3'; + } + + calDiv.appendChild(calTable); + } +} + +// Calendar -- A calendar instance +function Calendar(div_id, callback) { + // div_id (string) is the ID of the element in which the calendar will + // be displayed + // callback (string) is the name of a JavaScript function that will be + // called with the parameters (year, month, day) when a day in the + // calendar is clicked + this.div_id = div_id; + this.callback = callback; + this.today = new Date(); + this.currentMonth = this.today.getMonth() + 1; + this.currentYear = this.today.getFullYear(); +} +Calendar.prototype = { + drawCurrent: function() { + CalendarNamespace.draw(this.currentMonth, this.currentYear, this.div_id, this.callback); + }, + drawDate: function(month, year) { + this.currentMonth = month; + this.currentYear = year; + this.drawCurrent(); + }, + drawPreviousMonth: function() { + if (this.currentMonth == 1) { + this.currentMonth = 12; + this.currentYear--; + } + else { + this.currentMonth--; + } + this.drawCurrent(); + }, + drawNextMonth: function() { + if (this.currentMonth == 12) { + this.currentMonth = 1; + this.currentYear++; + } + else { + this.currentMonth++; + } + this.drawCurrent(); + }, + drawPreviousYear: function() { + this.currentYear--; + this.drawCurrent(); + }, + drawNextYear: function() { + this.currentYear++; + this.drawCurrent(); + } +} diff --git a/static/admin/media/js/core.js b/static/admin/media/js/core.js new file mode 100644 index 0000000..c8d0db6 --- /dev/null +++ b/static/admin/media/js/core.js @@ -0,0 +1,176 @@ +// Core javascript helper functions + +// basic browser identification & version +var isOpera = (navigator.userAgent.indexOf("Opera")>=0) && parseFloat(navigator.appVersion); +var isIE = ((document.all) && (!isOpera)) && parseFloat(navigator.appVersion.split("MSIE ")[1].split(";")[0]); + +// Cross-browser event handlers. +function addEvent(obj, evType, fn) { + if (obj.addEventListener) { + obj.addEventListener(evType, fn, false); + return true; + } else if (obj.attachEvent) { + var r = obj.attachEvent("on" + evType, fn); + return r; + } else { + return false; + } +} + +function removeEvent(obj, evType, fn) { + if (obj.removeEventListener) { + obj.removeEventListener(evType, fn, false); + return true; + } else if (obj.detachEvent) { + obj.detachEvent("on" + evType, fn); + return true; + } else { + return false; + } +} + +// quickElement(tagType, parentReference, textInChildNode, [, attribute, attributeValue ...]); +function quickElement() { + var obj = document.createElement(arguments[0]); + if (arguments[2] != '' && arguments[2] != null) { + var textNode = document.createTextNode(arguments[2]); + obj.appendChild(textNode); + } + var len = arguments.length; + for (var i = 3; i < len; i += 2) { + obj.setAttribute(arguments[i], arguments[i+1]); + } + arguments[1].appendChild(obj); + return obj; +} + +// ---------------------------------------------------------------------------- +// Cross-browser xmlhttp object +// from http://jibbering.com/2002/4/httprequest.html +// ---------------------------------------------------------------------------- +var xmlhttp; +/*@cc_on @*/ +/*@if (@_jscript_version >= 5) + try { + xmlhttp = new ActiveXObject("Msxml2.XMLHTTP"); + } catch (e) { + try { + xmlhttp = new ActiveXObject("Microsoft.XMLHTTP"); + } catch (E) { + xmlhttp = false; + } + } +@else + xmlhttp = false; +@end @*/ +if (!xmlhttp && typeof XMLHttpRequest != 'undefined') { + xmlhttp = new XMLHttpRequest(); +} + +// ---------------------------------------------------------------------------- +// Find-position functions by PPK +// See http://www.quirksmode.org/js/findpos.html +// ---------------------------------------------------------------------------- +function findPosX(obj) { + var curleft = 0; + if (obj.offsetParent) { + while (obj.offsetParent) { + curleft += obj.offsetLeft - ((isOpera) ? 0 : obj.scrollLeft); + obj = obj.offsetParent; + } + // IE offsetParent does not include the top-level + if (isIE && obj.parentElement){ + curleft += obj.offsetLeft - obj.scrollLeft; + } + } else if (obj.x) { + curleft += obj.x; + } + return curleft; +} + +function findPosY(obj) { + var curtop = 0; + if (obj.offsetParent) { + while (obj.offsetParent) { + curtop += obj.offsetTop - ((isOpera) ? 0 : obj.scrollTop); + obj = obj.offsetParent; + } + // IE offsetParent does not include the top-level + if (isIE && obj.parentElement){ + curtop += obj.offsetTop - obj.scrollTop; + } + } else if (obj.y) { + curtop += obj.y; + } + return curtop; +} + +//----------------------------------------------------------------------------- +// Date object extensions +// ---------------------------------------------------------------------------- +Date.prototype.getCorrectYear = function() { + // Date.getYear() is unreliable -- + // see http://www.quirksmode.org/js/introdate.html#year + var y = this.getYear() % 100; + return (y < 38) ? y + 2000 : y + 1900; +} + +Date.prototype.getTwoDigitMonth = function() { + return (this.getMonth() < 9) ? '0' + (this.getMonth()+1) : (this.getMonth()+1); +} + +Date.prototype.getTwoDigitDate = function() { + return (this.getDate() < 10) ? '0' + this.getDate() : this.getDate(); +} + +Date.prototype.getTwoDigitHour = function() { + return (this.getHours() < 10) ? '0' + this.getHours() : this.getHours(); +} + +Date.prototype.getTwoDigitMinute = function() { + return (this.getMinutes() < 10) ? '0' + this.getMinutes() : this.getMinutes(); +} + +Date.prototype.getTwoDigitSecond = function() { + return (this.getSeconds() < 10) ? '0' + this.getSeconds() : this.getSeconds(); +} + +Date.prototype.getISODate = function() { + return this.getCorrectYear() + '-' + this.getTwoDigitMonth() + '-' + this.getTwoDigitDate(); +} + +Date.prototype.getHourMinute = function() { + return this.getTwoDigitHour() + ':' + this.getTwoDigitMinute(); +} + +Date.prototype.getHourMinuteSecond = function() { + return this.getTwoDigitHour() + ':' + this.getTwoDigitMinute() + ':' + this.getTwoDigitSecond(); +} + +// ---------------------------------------------------------------------------- +// String object extensions +// ---------------------------------------------------------------------------- +String.prototype.pad_left = function(pad_length, pad_string) { + var new_string = this; + for (var i = 0; new_string.length < pad_length; i++) { + new_string = pad_string + new_string; + } + return new_string; +} + +// ---------------------------------------------------------------------------- +// Get the computed style for and element +// ---------------------------------------------------------------------------- +function getStyle(oElm, strCssRule){ + var strValue = ""; + if(document.defaultView && document.defaultView.getComputedStyle){ + strValue = document.defaultView.getComputedStyle(oElm, "").getPropertyValue(strCssRule); + } + else if(oElm.currentStyle){ + strCssRule = strCssRule.replace(/\-(\w)/g, function (strMatch, p1){ + return p1.toUpperCase(); + }); + strValue = oElm.currentStyle[strCssRule]; + } + return strValue; +} diff --git a/static/admin/media/js/dateparse.js b/static/admin/media/js/dateparse.js new file mode 100644 index 0000000..e1c870e --- /dev/null +++ b/static/admin/media/js/dateparse.js @@ -0,0 +1,233 @@ +/* 'Magic' date parsing, by Simon Willison (6th October 2003) + http://simon.incutio.com/archive/2003/10/06/betterDateInput + Adapted for 6newslawrence.com, 28th January 2004 +*/ + +/* Finds the index of the first occurence of item in the array, or -1 if not found */ +if (typeof Array.prototype.indexOf == 'undefined') { + Array.prototype.indexOf = function(item) { + var len = this.length; + for (var i = 0; i < len; i++) { + if (this[i] == item) { + return i; + } + } + return -1; + }; +} +/* Returns an array of items judged 'true' by the passed in test function */ +if (typeof Array.prototype.filter == 'undefined') { + Array.prototype.filter = function(test) { + var matches = []; + var len = this.length; + for (var i = 0; i < len; i++) { + if (test(this[i])) { + matches[matches.length] = this[i]; + } + } + return matches; + }; +} + +var monthNames = gettext("January February March April May June July August September October November December").split(" "); +var weekdayNames = gettext("Sunday Monday Tuesday Wednesday Thursday Friday Saturday").split(" "); + +/* Takes a string, returns the index of the month matching that string, throws + an error if 0 or more than 1 matches +*/ +function parseMonth(month) { + var matches = monthNames.filter(function(item) { + return new RegExp("^" + month, "i").test(item); + }); + if (matches.length == 0) { + throw new Error("Invalid month string"); + } + if (matches.length > 1) { + throw new Error("Ambiguous month"); + } + return monthNames.indexOf(matches[0]); +} +/* Same as parseMonth but for days of the week */ +function parseWeekday(weekday) { + var matches = weekdayNames.filter(function(item) { + return new RegExp("^" + weekday, "i").test(item); + }); + if (matches.length == 0) { + throw new Error("Invalid day string"); + } + if (matches.length > 1) { + throw new Error("Ambiguous weekday"); + } + return weekdayNames.indexOf(matches[0]); +} + +/* Array of objects, each has 're', a regular expression and 'handler', a + function for creating a date from something that matches the regular + expression. Handlers may throw errors if string is unparseable. +*/ +var dateParsePatterns = [ + // Today + { re: /^tod/i, + handler: function() { + return new Date(); + } + }, + // Tomorrow + { re: /^tom/i, + handler: function() { + var d = new Date(); + d.setDate(d.getDate() + 1); + return d; + } + }, + // Yesterday + { re: /^yes/i, + handler: function() { + var d = new Date(); + d.setDate(d.getDate() - 1); + return d; + } + }, + // 4th + { re: /^(\d{1,2})(st|nd|rd|th)?$/i, + handler: function(bits) { + var d = new Date(); + d.setDate(parseInt(bits[1], 10)); + return d; + } + }, + // 4th Jan + { re: /^(\d{1,2})(?:st|nd|rd|th)? (\w+)$/i, + handler: function(bits) { + var d = new Date(); + d.setDate(parseInt(bits[1], 10)); + d.setMonth(parseMonth(bits[2])); + return d; + } + }, + // 4th Jan 2003 + { re: /^(\d{1,2})(?:st|nd|rd|th)? (\w+),? (\d{4})$/i, + handler: function(bits) { + var d = new Date(); + d.setDate(parseInt(bits[1], 10)); + d.setMonth(parseMonth(bits[2])); + d.setYear(bits[3]); + return d; + } + }, + // Jan 4th + { re: /^(\w+) (\d{1,2})(?:st|nd|rd|th)?$/i, + handler: function(bits) { + var d = new Date(); + d.setDate(parseInt(bits[2], 10)); + d.setMonth(parseMonth(bits[1])); + return d; + } + }, + // Jan 4th 2003 + { re: /^(\w+) (\d{1,2})(?:st|nd|rd|th)?,? (\d{4})$/i, + handler: function(bits) { + var d = new Date(); + d.setDate(parseInt(bits[2], 10)); + d.setMonth(parseMonth(bits[1])); + d.setYear(bits[3]); + return d; + } + }, + // next Tuesday - this is suspect due to weird meaning of "next" + { re: /^next (\w+)$/i, + handler: function(bits) { + var d = new Date(); + var day = d.getDay(); + var newDay = parseWeekday(bits[1]); + var addDays = newDay - day; + if (newDay <= day) { + addDays += 7; + } + d.setDate(d.getDate() + addDays); + return d; + } + }, + // last Tuesday + { re: /^last (\w+)$/i, + handler: function(bits) { + throw new Error("Not yet implemented"); + } + }, + // mm/dd/yyyy (American style) + { re: /(\d{1,2})\/(\d{1,2})\/(\d{4})/, + handler: function(bits) { + var d = new Date(); + d.setYear(bits[3]); + d.setDate(parseInt(bits[2], 10)); + d.setMonth(parseInt(bits[1], 10) - 1); // Because months indexed from 0 + return d; + } + }, + // yyyy-mm-dd (ISO style) + { re: /(\d{4})-(\d{1,2})-(\d{1,2})/, + handler: function(bits) { + var d = new Date(); + d.setYear(parseInt(bits[1])); + d.setMonth(parseInt(bits[2], 10) - 1); + d.setDate(parseInt(bits[3], 10)); + return d; + } + }, +]; + +function parseDateString(s) { + for (var i = 0; i < dateParsePatterns.length; i++) { + var re = dateParsePatterns[i].re; + var handler = dateParsePatterns[i].handler; + var bits = re.exec(s); + if (bits) { + return handler(bits); + } + } + throw new Error("Invalid date string"); +} + +function fmt00(x) { + // fmt00: Tags leading zero onto numbers 0 - 9. + // Particularly useful for displaying results from Date methods. + // + if (Math.abs(parseInt(x)) < 10){ + x = "0"+ Math.abs(x); + } + return x; +} + +function parseDateStringISO(s) { + try { + var d = parseDateString(s); + return d.getFullYear() + '-' + (fmt00(d.getMonth() + 1)) + '-' + fmt00(d.getDate()) + } + catch (e) { return s; } +} +function magicDate(input) { + var messagespan = input.id + 'Msg'; + try { + var d = parseDateString(input.value); + input.value = d.getFullYear() + '-' + (fmt00(d.getMonth() + 1)) + '-' + + fmt00(d.getDate()); + input.className = ''; + // Human readable date + if (document.getElementById(messagespan)) { + document.getElementById(messagespan).firstChild.nodeValue = d.toDateString(); + document.getElementById(messagespan).className = 'normal'; + } + } + catch (e) { + input.className = 'error'; + var message = e.message; + // Fix for IE6 bug + if (message.indexOf('is null or not an object') > -1) { + message = 'Invalid date string'; + } + if (document.getElementById(messagespan)) { + document.getElementById(messagespan).firstChild.nodeValue = message; + document.getElementById(messagespan).className = 'error'; + } + } +} diff --git a/static/admin/media/js/getElementsBySelector.js b/static/admin/media/js/getElementsBySelector.js new file mode 100644 index 0000000..15b57a1 --- /dev/null +++ b/static/admin/media/js/getElementsBySelector.js @@ -0,0 +1,167 @@ +/* document.getElementsBySelector(selector) + - returns an array of element objects from the current document + matching the CSS selector. Selectors can contain element names, + class names and ids and can be nested. For example: + + elements = document.getElementsBySelect('div#main p a.external') + + Will return an array of all 'a' elements with 'external' in their + class attribute that are contained inside 'p' elements that are + contained inside the 'div' element which has id="main" + + New in version 0.4: Support for CSS2 and CSS3 attribute selectors: + See http://www.w3.org/TR/css3-selectors/#attribute-selectors + + Version 0.4 - Simon Willison, March 25th 2003 + -- Works in Phoenix 0.5, Mozilla 1.3, Opera 7, Internet Explorer 6, Internet Explorer 5 on Windows + -- Opera 7 fails +*/ + +function getAllChildren(e) { + // Returns all children of element. Workaround required for IE5/Windows. Ugh. + return e.all ? e.all : e.getElementsByTagName('*'); +} + +document.getElementsBySelector = function(selector) { + // Attempt to fail gracefully in lesser browsers + if (!document.getElementsByTagName) { + return new Array(); + } + // Split selector in to tokens + var tokens = selector.split(' '); + var currentContext = new Array(document); + for (var i = 0; i < tokens.length; i++) { + token = tokens[i].replace(/^\s+/,'').replace(/\s+$/,'');; + if (token.indexOf('#') > -1) { + // Token is an ID selector + var bits = token.split('#'); + var tagName = bits[0]; + var id = bits[1]; + var element = document.getElementById(id); + if (!element || (tagName && element.nodeName.toLowerCase() != tagName)) { + // ID not found or tag with that ID not found, return false. + return new Array(); + } + // Set currentContext to contain just this element + currentContext = new Array(element); + continue; // Skip to next token + } + if (token.indexOf('.') > -1) { + // Token contains a class selector + var bits = token.split('.'); + var tagName = bits[0]; + var className = bits[1]; + if (!tagName) { + tagName = '*'; + } + // Get elements matching tag, filter them for class selector + var found = new Array; + var foundCount = 0; + for (var h = 0; h < currentContext.length; h++) { + var elements; + if (tagName == '*') { + elements = getAllChildren(currentContext[h]); + } else { + try { + elements = currentContext[h].getElementsByTagName(tagName); + } + catch(e) { + elements = []; + } + } + for (var j = 0; j < elements.length; j++) { + found[foundCount++] = elements[j]; + } + } + currentContext = new Array; + var currentContextIndex = 0; + for (var k = 0; k < found.length; k++) { + if (found[k].className && found[k].className.match(new RegExp('\\b'+className+'\\b'))) { + currentContext[currentContextIndex++] = found[k]; + } + } + continue; // Skip to next token + } + // Code to deal with attribute selectors + if (token.match(/^(\w*)\[(\w+)([=~\|\^\$\*]?)=?"?([^\]"]*)"?\]$/)) { + var tagName = RegExp.$1; + var attrName = RegExp.$2; + var attrOperator = RegExp.$3; + var attrValue = RegExp.$4; + if (!tagName) { + tagName = '*'; + } + // Grab all of the tagName elements within current context + var found = new Array; + var foundCount = 0; + for (var h = 0; h < currentContext.length; h++) { + var elements; + if (tagName == '*') { + elements = getAllChildren(currentContext[h]); + } else { + elements = currentContext[h].getElementsByTagName(tagName); + } + for (var j = 0; j < elements.length; j++) { + found[foundCount++] = elements[j]; + } + } + currentContext = new Array; + var currentContextIndex = 0; + var checkFunction; // This function will be used to filter the elements + switch (attrOperator) { + case '=': // Equality + checkFunction = function(e) { return (e.getAttribute(attrName) == attrValue); }; + break; + case '~': // Match one of space seperated words + checkFunction = function(e) { return (e.getAttribute(attrName).match(new RegExp('\\b'+attrValue+'\\b'))); }; + break; + case '|': // Match start with value followed by optional hyphen + checkFunction = function(e) { return (e.getAttribute(attrName).match(new RegExp('^'+attrValue+'-?'))); }; + break; + case '^': // Match starts with value + checkFunction = function(e) { return (e.getAttribute(attrName).indexOf(attrValue) == 0); }; + break; + case '$': // Match ends with value - fails with "Warning" in Opera 7 + checkFunction = function(e) { return (e.getAttribute(attrName).lastIndexOf(attrValue) == e.getAttribute(attrName).length - attrValue.length); }; + break; + case '*': // Match ends with value + checkFunction = function(e) { return (e.getAttribute(attrName).indexOf(attrValue) > -1); }; + break; + default : + // Just test for existence of attribute + checkFunction = function(e) { return e.getAttribute(attrName); }; + } + currentContext = new Array; + var currentContextIndex = 0; + for (var k = 0; k < found.length; k++) { + if (checkFunction(found[k])) { + currentContext[currentContextIndex++] = found[k]; + } + } + // alert('Attribute Selector: '+tagName+' '+attrName+' '+attrOperator+' '+attrValue); + continue; // Skip to next token + } + // If we get here, token is JUST an element (not a class or ID selector) + tagName = token; + var found = new Array; + var foundCount = 0; + for (var h = 0; h < currentContext.length; h++) { + var elements = currentContext[h].getElementsByTagName(tagName); + for (var j = 0; j < elements.length; j++) { + found[foundCount++] = elements[j]; + } + } + currentContext = found; + } + return currentContext; +} + +/* That revolting regular expression explained +/^(\w+)\[(\w+)([=~\|\^\$\*]?)=?"?([^\]"]*)"?\]$/ + \---/ \---/\-------------/ \-------/ + | | | | + | | | The value + | | ~,|,^,$,* or = + | Attribute + Tag +*/ diff --git a/static/admin/media/js/timeparse.js b/static/admin/media/js/timeparse.js new file mode 100644 index 0000000..882f41d --- /dev/null +++ b/static/admin/media/js/timeparse.js @@ -0,0 +1,94 @@ +var timeParsePatterns = [ + // 9 + { re: /^\d{1,2}$/i, + handler: function(bits) { + if (bits[0].length == 1) { + return '0' + bits[0] + ':00'; + } else { + return bits[0] + ':00'; + } + } + }, + // 13:00 + { re: /^\d{2}[:.]\d{2}$/i, + handler: function(bits) { + return bits[0].replace('.', ':'); + } + }, + // 9:00 + { re: /^\d[:.]\d{2}$/i, + handler: function(bits) { + return '0' + bits[0].replace('.', ':'); + } + }, + // 3 am / 3 a.m. / 3am + { re: /^(\d+)\s*([ap])(?:.?m.?)?$/i, + handler: function(bits) { + var hour = parseInt(bits[1]); + if (hour == 12) { + hour = 0; + } + if (bits[2].toLowerCase() == 'p') { + if (hour == 12) { + hour = 0; + } + return (hour + 12) + ':00'; + } else { + if (hour < 10) { + return '0' + hour + ':00'; + } else { + return hour + ':00'; + } + } + } + }, + // 3.30 am / 3:15 a.m. / 3.00am + { re: /^(\d+)[.:](\d{2})\s*([ap]).?m.?$/i, + handler: function(bits) { + var hour = parseInt(bits[1]); + var mins = parseInt(bits[2]); + if (mins < 10) { + mins = '0' + mins; + } + if (hour == 12) { + hour = 0; + } + if (bits[3].toLowerCase() == 'p') { + if (hour == 12) { + hour = 0; + } + return (hour + 12) + ':' + mins; + } else { + if (hour < 10) { + return '0' + hour + ':' + mins; + } else { + return hour + ':' + mins; + } + } + } + }, + // noon + { re: /^no/i, + handler: function(bits) { + return '12:00'; + } + }, + // midnight + { re: /^mid/i, + handler: function(bits) { + return '00:00'; + } + } +]; + +function parseTimeString(s) { + for (var i = 0; i < timeParsePatterns.length; i++) { + var re = timeParsePatterns[i].re; + var handler = timeParsePatterns[i].handler; + var bits = re.exec(s); + if (bits) { + return handler(bits); + } + } + return s; +} diff --git a/static/admin/media/js/urlify.js b/static/admin/media/js/urlify.js new file mode 100644 index 0000000..d8f2549 --- /dev/null +++ b/static/admin/media/js/urlify.js @@ -0,0 +1,140 @@ +var LATIN_MAP = { + 'À': 'A', 'Á': 'A', 'Â': 'A', 'Ã': 'A', 'Ä': 'A', 'Å': 'A', 'Æ': 'AE', 'Ç': + 'C', 'È': 'E', 'É': 'E', 'Ê': 'E', 'Ë': 'E', 'Ì': 'I', 'Í': 'I', 'Î': 'I', + 'Ï': 'I', 'Ð': 'D', 'Ñ': 'N', 'Ò': 'O', 'Ó': 'O', 'Ô': 'O', 'Õ': 'O', 'Ö': + 'O', 'Ő': 'O', 'Ø': 'O', 'Ù': 'U', 'Ú': 'U', 'Û': 'U', 'Ü': 'U', 'Ű': 'U', + 'Ý': 'Y', 'Þ': 'TH', 'ß': 'ss', 'à':'a', 'á':'a', 'â': 'a', 'ã': 'a', 'ä': + 'a', 'Ã¥': 'a', 'æ': 'ae', 'ç': 'c', 'è': 'e', 'é': 'e', 'ê': 'e', 'ë': 'e', + 'ì': 'i', 'í': 'i', 'î': 'i', 'ï': 'i', 'ð': 'd', 'ñ': 'n', 'ò': 'o', 'ó': + 'o', 'ô': 'o', 'õ': 'o', 'ö': 'o', 'ő': 'o', 'ø': 'o', 'ù': 'u', 'ú': 'u', + 'û': 'u', 'ü': 'u', 'ű': 'u', 'ý': 'y', 'þ': 'th', 'ÿ': 'y' +} +var LATIN_SYMBOLS_MAP = { + '©':'(c)' +} +var GREEK_MAP = { + 'α':'a', 'β':'b', 'γ':'g', 'δ':'d', 'ε':'e', 'ζ':'z', 'η':'h', 'θ':'8', + 'ι':'i', 'κ':'k', 'λ':'l', 'μ':'m', 'ν':'n', 'ξ':'3', 'ο':'o', 'π':'p', + 'ρ':'r', 'σ':'s', 'τ':'t', 'υ':'y', 'φ':'f', 'χ':'x', 'ψ':'ps', 'ω':'w', + 'ά':'a', 'έ':'e', 'ί':'i', 'ό':'o', 'ύ':'y', 'ή':'h', 'ώ':'w', 'ς':'s', + 'ϊ':'i', 'ΰ':'y', 'ϋ':'y', 'ΐ':'i', + 'Α':'A', 'Β':'B', 'Γ':'G', 'Δ':'D', 'Ε':'E', 'Ζ':'Z', 'Η':'H', 'Θ':'8', + 'Ι':'I', 'Κ':'K', 'Λ':'L', 'Μ':'M', 'Ν':'N', 'Ξ':'3', 'Ο':'O', 'Π':'P', + 'Ρ':'R', 'Σ':'S', 'Τ':'T', 'Î¥':'Y', 'Φ':'F', 'Χ':'X', 'Ψ':'PS', 'Ω':'W', + 'Ά':'A', 'Έ':'E', 'Ί':'I', 'Ό':'O', 'Ύ':'Y', 'Ή':'H', 'Ώ':'W', 'Ϊ':'I', + 'Ϋ':'Y' +} +var TURKISH_MAP = { + 'ş':'s', 'Ş':'S', 'ı':'i', 'İ':'I', 'ç':'c', 'Ç':'C', 'ü':'u', 'Ü':'U', + 'ö':'o', 'Ö':'O', 'ğ':'g', 'Ğ':'G' +} +var RUSSIAN_MAP = { + 'а':'a', 'б':'b', 'в':'v', 'г':'g', 'д':'d', 'е':'e', 'ё':'yo', 'ж':'zh', + 'з':'z', 'и':'i', 'й':'j', 'к':'k', 'л':'l', 'м':'m', 'н':'n', 'о':'o', + 'п':'p', 'р':'r', 'с':'s', 'т':'t', 'у':'u', 'ф':'f', 'х':'h', 'ц':'c', + 'ч':'ch', 'ш':'sh', 'щ':'sh', 'ъ':'', 'ы':'y', 'ь':'', 'э':'e', 'ю':'yu', + 'я':'ya', + 'А':'A', 'Б':'B', 'В':'V', 'Г':'G', 'Д':'D', 'Е':'E', 'Ё':'Yo', 'Ж':'Zh', + 'З':'Z', 'И':'I', 'Й':'J', 'К':'K', 'Л':'L', 'М':'M', 'Н':'N', 'О':'O', + 'П':'P', 'Р':'R', 'С':'S', 'Т':'T', 'У':'U', 'Ф':'F', 'Ð¥':'H', 'Ц':'C', + 'Ч':'Ch', 'Ш':'Sh', 'Щ':'Sh', 'Ъ':'', 'Ы':'Y', 'Ь':'', 'Э':'E', 'Ю':'Yu', + 'Я':'Ya' +} +var UKRAINIAN_MAP = { + 'Є':'Ye', 'І':'I', 'Ї':'Yi', 'Ґ':'G', 'є':'ye', 'і':'i', 'ї':'yi', 'ґ':'g' +} +var CZECH_MAP = { + 'č':'c', 'ď':'d', 'ě':'e', 'ň': 'n', 'ř':'r', 'Å¡':'s', 'Å¥':'t', 'ů':'u', + 'ž':'z', 'Č':'C', 'Ď':'D', 'Ě':'E', 'Ň': 'N', 'Ř':'R', 'Å ':'S', 'Ť':'T', + 'Å®':'U', 'Ž':'Z' +} + +var POLISH_MAP = { + 'ą':'a', 'ć':'c', 'ę':'e', 'ł':'l', 'ń':'n', 'ó':'o', 'ś':'s', 'ź':'z', + 'ż':'z', 'Ą':'A', 'Ć':'C', 'Ę':'e', 'Ł':'L', 'Ń':'N', 'Ó':'o', 'Ś':'S', + 'Ź':'Z', 'Å»':'Z' +} + +var LATVIAN_MAP = { + 'ā':'a', 'č':'c', 'ē':'e', 'Ä£':'g', 'Ä«':'i', 'Ä·':'k', 'ļ':'l', 'ņ':'n', + 'Å¡':'s', 'Å«':'u', 'ž':'z', 'Ā':'A', 'Č':'C', 'Ē':'E', 'Ä¢':'G', 'Ī':'i', + 'Ķ':'k', 'Ä»':'L', 'Ņ':'N', 'Å ':'S', 'Ū':'u', 'Ž':'Z' +} + +var ALL_DOWNCODE_MAPS=new Array() +ALL_DOWNCODE_MAPS[0]=LATIN_MAP +ALL_DOWNCODE_MAPS[1]=LATIN_SYMBOLS_MAP +ALL_DOWNCODE_MAPS[2]=GREEK_MAP +ALL_DOWNCODE_MAPS[3]=TURKISH_MAP +ALL_DOWNCODE_MAPS[4]=RUSSIAN_MAP +ALL_DOWNCODE_MAPS[5]=UKRAINIAN_MAP +ALL_DOWNCODE_MAPS[6]=CZECH_MAP +ALL_DOWNCODE_MAPS[7]=POLISH_MAP +ALL_DOWNCODE_MAPS[8]=LATVIAN_MAP + +var Downcoder = new Object(); +Downcoder.Initialize = function() +{ + if (Downcoder.map) // already made + return ; + Downcoder.map ={} + Downcoder.chars = '' ; + for(var i in ALL_DOWNCODE_MAPS) + { + var lookup = ALL_DOWNCODE_MAPS[i] + for (var c in lookup) + { + Downcoder.map[c] = lookup[c] ; + Downcoder.chars += c ; + } + } + Downcoder.regex = new RegExp('[' + Downcoder.chars + ']|[^' + Downcoder.chars + ']+','g') ; +} + +downcode= function( slug ) +{ + Downcoder.Initialize() ; + var downcoded ="" + var pieces = slug.match(Downcoder.regex); + if(pieces) + { + for (var i = 0 ; i < pieces.length ; i++) + { + if (pieces[i].length == 1) + { + var mapped = Downcoder.map[pieces[i]] ; + if (mapped != null) + { + downcoded+=mapped; + continue ; + } + } + downcoded+=pieces[i]; + } + } + else + { + downcoded = slug; + } + return downcoded; +} + + +function URLify(s, num_chars) { + // changes, e.g., "Petty theft" to "petty_theft" + // remove all these words from the string before urlifying + s = downcode(s); + removelist = ["a", "an", "as", "at", "before", "but", "by", "for", "from", + "is", "in", "into", "like", "of", "off", "on", "onto", "per", + "since", "than", "the", "this", "that", "to", "up", "via", + "with"]; + r = new RegExp('\\b(' + removelist.join('|') + ')\\b', 'gi'); + s = s.replace(r, ''); + // if downcode doesn't hit, the char will be stripped here + s = s.replace(/[^-\w\s]/g, ''); // remove unneeded chars + s = s.replace(/^\s+|\s+$/g, ''); // trim leading/trailing spaces + s = s.replace(/[-\s]+/g, '-'); // convert spaces to hyphens + s = s.toLowerCase(); // convert to lowercase + return s.substring(0, num_chars);// trim to first num_chars chars +} + diff --git a/subjecten/models.py b/subjecten/models.py index 95988ad..73eb2bc 100644 --- a/subjecten/models.py +++ b/subjecten/models.py @@ -1,60 +1,68 @@ import re from django.db import models from django import forms # Models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() geboortedatum = models.DateField() class Meta: verbose_name_plural = "subjecten" + def aantal_zaken(self): + # Warning: this function could be the cause of + # performance issues. If you show all subjecten and for + # each subject you show its number of zaken then this could + # cause a lot of queries to be executed. You can counter this + # by using select_related() strategically. + return self.zaak_set.filter(subject = self.id).count() + def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) # Form validators class DutchPostcodeField(forms.Field): def clean(self, value): '''Check that input is a valid Dutch postcode''' m = re.match(r'^([0-9]{4})\s?([a-zA-Z]{2}$)', value) # pattern: 1234 AA if not m or len(m.groups()) != 2: raise forms.ValidationError('Een Nederlandse postcode ziet er als volgt uit: 1234 AA') return "%s %s" % (m.groups()[0], m.groups()[1].upper()) class AmsterdamPostcodeField(DutchPostcodeField): def clean(self, value): '''Check that input is a valid Dutch postcode and check that Dutch postcode is within the Amsterdam postcode ranges. ''' value = super(AmsterdamPostcodeField, self).clean(value) n = int(value[0:4]) if not(1000 <= n <= 1099) and not(1100 <= n <= 1108): # postcode not in Amsterdam ranges raise forms.ValidationError('Voer een Amsterdamse postcode in.') return value # Forms class SubjectForm(forms.ModelForm): woonadres_postcode = AmsterdamPostcodeField() correspondentie_postcode = DutchPostcodeField() class Meta: model = Subject \ No newline at end of file diff --git a/subjecten/urls.py b/subjecten/urls.py index 2f11e9c..0df52bb 100644 --- a/subjecten/urls.py +++ b/subjecten/urls.py @@ -1,10 +1,25 @@ from django.conf.urls.defaults import * -urlpatterns = patterns('djangodemo.subjecten.views', - (r'^$', 'index'), - (r'^(?P<subject_id>\d+)/$', 'detail'), - (r'^(?P<subject_id>\d+)/edit/$', 'edit'), - (r'^(?P<subject_id>\d+)/wijzig/$', 'edit'), - (r'^nieuw/$', 'new'), - (r'^new/$', 'new'), -) \ No newline at end of file +from djangodemo.zaken.models import Zaak +from djangodemo.subjecten.models import Subject + +# list/detail van subjecten +subjecten = Subject.objects.select_related().all() +urlpatterns = patterns('django.views.generic.list_detail', + (r'^$', 'object_list', { + 'queryset': subjecten, + 'template_name': 'subjecten/index.html', + 'template_object_name': 'subject', + 'paginate_by': 25}), + (r'^(?P<object_id>\d+)/$', 'object_detail', { + 'queryset': subjecten, + 'template_name': 'subjecten/detail.html', + 'template_object_name': 'subject'}), +) + +# CRUD pagina's subjecten en zaak functies bij subject +urlpatterns += patterns('djangodemo.subjecten.views', + (r'^(?P<subject_id>\d+)/(edit|wijzig)/$', 'edit'), + (r'^(?P<subject_id>\d+)/zaken/$', 'zaken'), + (r'^(?P<subject_id>\d+)/zaken/(new|nieuw)/$', 'new_zaak_for_subject'), +) diff --git a/subjecten/views.py b/subjecten/views.py index f565e2e..1dec735 100644 --- a/subjecten/views.py +++ b/subjecten/views.py @@ -1,42 +1,58 @@ -from django.shortcuts import render_to_response from django.http import HttpResponseRedirect +from django.shortcuts import render_to_response +from django.shortcuts import get_object_or_404 +from django.views.generic import create_update from djangodemo.subjecten.models import Subject, SubjectForm - -def index(request): - '''Lijst van alle subjecten''' - - subjecten = Subject.objects.all() - return render_to_response('subjecten/index.html', {'subjecten': subjecten}) - -def detail(request, subject_id): - '''Details van een subject''' - - subject = Subject.objects.get(pk = subject_id) - return render_to_response('subjecten/detail.html', {'subject': subject}) +from djangodemo.zaken.models import Zaak, NewZaakForSubjectForm def new(request): '''Show form to add new subject''' if request.method == "POST": form = SubjectForm(request.POST) #prefilled form from POST data if form.is_valid(): new_subject = form.save() return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) else: form = SubjectForm() #empty form return render_to_response('subjecten/new_subject.html', {'form': form}) def edit(request, subject_id = None): '''Show form to change an existing subject''' if request.method == "POST": subject = Subject.objects.get(pk = subject_id) form = SubjectForm(request.POST, instance = subject) if form.is_valid(): new_subject = form.save() return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) else: subject = Subject.objects.get(pk = subject_id) form = SubjectForm(instance = subject) - return render_to_response('subjecten/edit_subject.html', {'form': form, 'subject': subject}) \ No newline at end of file + return render_to_response('subjecten/edit_subject.html', {'form': form, 'subject': subject}) + +def zaken(request, subject_id): + '''Show zaken for this subject''' + + zaken = Zaak.objects.filter(subject = subject_id) + subject = Subject.objects.get(pk = subject_id) + return render_to_response('subjecten/zaken.html', {'zaken': zaken, 'subject': subject}) + +def new_zaak_for_subject(request, subject_id): + '''Create new zaak for a subject''' + + subject = get_object_or_404(Subject, pk = subject_id) + + if request.method == "POST": + form = NewZaakForSubjectForm(request.POST) #prefilled form from POST data + if form.is_valid(): + new_zaak = Zaak() + new_zaak.subject = subject + for k,v in form.cleaned_data.iteritems(): + setattr(new_zaak, k, v) + new_zaak.save() + return HttpResponseRedirect("/subjecten/%s/zaken/" % subject.pk) + else: + form = NewZaakForSubjectForm() #empty form + return render_to_response('subjecten/new_zaak_for_subject.html', {'form': form, 'subject': subject}) \ No newline at end of file diff --git a/templates/base.html b/templates/base.html index cb684ae..a8c4c3e 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,39 +1,40 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <title>Demo Django &amp; Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css"> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css"> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css"> <![endif]--> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head> <body> <div class="container"> <div id="header"> <h1>Demo Zaakgericht Werken</h1> <p>Alle gegevens die hier getoond worden zijn fictief en uit de duim gezogen. Elke overeenkomst met de werkelijkheid berust op toeval.</p> </div> <div id="menu"> <h2>Menu</h2> <ul> <li><a href="/subjecten">Cliënten</a></li> + <li><a href="/zaken">Zaken</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy; 2010 - My Business</li> </ul> </div> </div> </body> </html> \ No newline at end of file diff --git a/templates/subjecten/detail.html b/templates/subjecten/detail.html index 07e6e50..46daac4 100644 --- a/templates/subjecten/detail.html +++ b/templates/subjecten/detail.html @@ -1,54 +1,55 @@ {% extends "base.html" %} {% load subjecten_extras %} {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <ul class="commandmenu"> <li>Acties:</li> <li><a href="/subjecten/{{ subject.pk }}/edit/">Wijzig cliëntgegevens</a></li> + <li><a href="/subjecten/{{ subject.pk }}/zaken/">Zaken van {{ subject }}</a> ({{ subject.aantal_zaken }})</li> </ul> <table> <tr> <th>Details</th> </tr> <tr> <td>Burgerservicenummer: &nbsp;{{ subject.bsn }}</td> </tr> <tr> <td>Geboortedatum: &nbsp;{{ subject.geboortedatum|date:"j F Y" }} ({{ subject.geboortedatum|leeftijd }} jaar)</td> </tr> </table> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> {{ subject.woonadres_postcode }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> {{ subject.correspondentie_postcode }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> <table> <tr> <th>Contact</th> </tr> <tr> <td> e-mail: {{ subject.email }} </td> </tr> <tr> <td> telefoon: {{ subject.telefoonnummer }} </td> </tr> </table> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html index b26efb2..639c0e0 100644 --- a/templates/subjecten/index.html +++ b/templates/subjecten/index.html @@ -1,27 +1,44 @@ {% extends "base.html" %} {% load subjecten_extras %} {% block content %} <h2>Lijst van cliënten</h2> <ul class="commandmenu"> <li>Acties:</li> <li><a href="/subjecten/new/">Cliënt opvoeren</a></li> </ul> <table> <tr> <th>Naam</th> <th>Burgerservicenummer</th> <th>Postcode</th> <th>Woonplaats</th> + <th>Aantal zaken</th> </tr> - {% for subject in subjecten %} + {% for subject in subject_list %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a> ({{ subject.geboortedatum|leeftijd }} jaar)</td> <td>{{ subject.bsn}}</td> <td>{{ subject.woonadres_postcode }}</td> <td>{{ subject.woonadres_woonplaats|upper }}</td> + <td><a href="/subjecten/{{ subject.id }}/zaken/">{{ subject.aantal_zaken }}</td> </tr> {% endfor %} </table> + <div class="pagination"> + <span class="step-links"> + {% if page_obj.has_previous %} + <a href="?page={{ page_obj.previous_page_number }}">vorige</a>&nbsp;- + {% endif %} + + <span class="current"> + Pagina {{ page_obj.number }} van {{ paginator.num_pages }} + </span> + + {% if page_obj.has_next %} + &nbsp;- <a href="?page={{ page_obj.next_page_number }}">volgende</a> + {% endif %} + </span> + </div> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/new_zaak_for_subject.html b/templates/subjecten/new_zaak_for_subject.html new file mode 100644 index 0000000..370fbce --- /dev/null +++ b/templates/subjecten/new_zaak_for_subject.html @@ -0,0 +1,45 @@ +{% extends "base.html" %} + +{% block content %} + <h2>Nieuwe zaak voor cliënt aanmaken</h2> + <table> + <tr> + <th>Details cliënt</th> + </tr> + <tr> + <td> + <span class="label">Naam:</span> {{ subject.voorletters}} {{ subject.tussenvoegsels }} {{ subject.achternaam }} + </td> + </tr> + <tr> + <td> + <span class="label">Burgerservicenummer: </span>{{ subject.bsn }} + </td> + </tr> + <tr> + <td> + <span class="label">Geboortedatum:</span> {{ subject.geboortedatum }} + </td> + </tr> + </table> + {{ form.errors }} + <form action="/subjecten/{{ subject.pk }}/zaken/new/" method="post"> + <table> + <tr> + <th>Nieuwe zaak</th> + </tr> + <tr> + <td> + <span class="label">Type zaak:</span> {{ form.type_zaak}} + </td> + </tr> + <tr> + <td> + <span class="label">Opmerkingen: </span>{{ form.opmerkingen }} + </td> + </tr> + </table> + <a href="/subjecten/{{ subject.pk }}/zaken/"><input type="button" value="Annuleer" /></a> + <input type="submit" value="Bewaar" /> + </form> +{% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/zaken.html b/templates/subjecten/zaken.html new file mode 100644 index 0000000..c8b9d0e --- /dev/null +++ b/templates/subjecten/zaken.html @@ -0,0 +1,33 @@ +{% extends "base.html" %} + +{% load subjecten_extras %} + +{% block content %} + <h2>Zaken van <a href="/subjecten/{{ subject.pk }}/">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></h2> + + <ul class="commandmenu"> + <li>Acties:</li> + <li><a href="/subjecten/{{ subject.pk }}/zaken/new/">nieuwe zaak aanmaken voor {{ subject }}</a></li> + </ul> + + {% if zaken %} + <table> + <tr> + <th>Zaaktype</th> + <th>Startdatum</th> + <th>Wijzigingsdatum</th> + <th>Opmerkingen</th> + </tr> + {% for zaak in zaken %} + <tr> + <td><a href="/zaken/{{ zaak.id }}/">{{ zaak }}</a></td> + <td>{{ zaak.datum_start|date:"j F Y G:H" }}</td> + <td>{{ zaak.datum_wijziging|date:"j F Y G:H" }}</td> + <td>{{ zaak.opmerkingen }}</td> + </tr> + {% endfor %} + </table> + {% else %} + <p>De cliënt heeft geen zaken.</p> + {% endif %} +{% endblock content %} \ No newline at end of file diff --git a/templates/zaken/detail.html b/templates/zaken/detail.html new file mode 100644 index 0000000..21740d4 --- /dev/null +++ b/templates/zaken/detail.html @@ -0,0 +1,43 @@ +{% extends "base.html" %} + +{% load subjecten_extras %} + +{% block content %} + <h2>Zaakdetails van {{ zaak }}</h2> + <ul class="commandmenu"> + <li>Acties:</li> + <li><a href="/zaken/{{ zaak.pk }}/edit/">Wijzig zaakdetails</a></li> + <li><a href="/subjecten/{{ zaak.subject.id }}/zaken/">Zaken van {{ zaak.subject }} ({{ zaak.subject.aantal_zaken }})</a></li> + </ul> + <table> + <tr> + <th>Gegevens cliënt</th> + </tr> + <tr> + <td>Naam: &nbsp;<a href="/subjecten/{{ zaak.subject.pk }}/">{{ zaak.subject }}</a></td> + </tr> + <tr> + <td>Burgerservicenummer: &nbsp;{{ zaak.subject.bsn }}</td> + </tr> + <tr> + <td>Geboortedatum: &nbsp;{{ zaak.subject.geboortedatum|date:"j F Y" }} ({{ zaak.subject.geboortedatum|leeftijd }} jaar)</td> + </tr> + </table> + <table> + <tr> + <th>Details</th> + </tr> + <tr> + <td>Zaaktype: {{ zaak }}</td> + </tr> + <tr> + <td>Startdatum: {{ zaak.datum_start|date:"j F Y G:H" }}</td> + </tr> + <tr> + <td>Wijzigingsdatum: {{ zaak.datum_wijziging|date:"j F Y G:H" }}</td> + </tr> + <tr> + <td>Opmerkingen: {{ zaak.opmerkingen }}</td> + </tr> + </table> +{% endblock content %} \ No newline at end of file diff --git a/templates/zaken/edit_zaak.html b/templates/zaken/edit_zaak.html new file mode 100644 index 0000000..cbbbb3f --- /dev/null +++ b/templates/zaken/edit_zaak.html @@ -0,0 +1,45 @@ +{% extends "base.html" %} + +{% block content %} + <h2>Wijzig zaak voor cliënt</h2> + <table> + <tr> + <th>Details cliënt</th> + </tr> + <tr> + <td> + <span class="label">Naam:</span> {{ zaak.subject.voorletters}} {{ zaak.subject.tussenvoegsels }} {{ zaak.subject.achternaam }} + </td> + </tr> + <tr> + <td> + <span class="label">Burgerservicenummer: </span>{{ zaak.subject.bsn }} + </td> + </tr> + <tr> + <td> + <span class="label">Geboortedatum:</span> {{ zaak.subject.geboortedatum }} + </td> + </tr> + </table> + {{ form.errors }} + <form action="/zaken/{{ zaak.pk }}/edit/" method="post"> + <table> + <tr> + <th>Nieuwe zaak</th> + </tr> + <tr> + <td> + <span class="label">Type zaak:</span> {{ form.type_zaak}} + </td> + </tr> + <tr> + <td> + <span class="label">Opmerkingen: </span>{{ form.opmerkingen }} + </td> + </tr> + </table> + <a href="/zaken/{{ zaak.pk }}/"><input type="button" value="Annuleer" /></a> + <input type="submit" value="Bewaar" /> + </form> +{% endblock content %} \ No newline at end of file diff --git a/templates/zaken/index.html b/templates/zaken/index.html new file mode 100644 index 0000000..302715c --- /dev/null +++ b/templates/zaken/index.html @@ -0,0 +1,43 @@ +{% extends "base.html" %} + +{% block content %} + <h2>Lijst van zaken</h2> + <ul class="commandmenu"> + <li>Acties:</li> + <li>-</li> + </ul> + <table> + <tr> + <th>Type zaak</th> + <th>Startdatum</th> + <th>Wijzigingsdatum</th> + <th>Opmerking</th> + <th>Cliënt</th> + </tr> + + {% for zaak in zaak_list %} + <tr> + <td><a href="/zaken/{{ zaak.id }}/">{{ zaak.type_zaak }}</a></td> + <td>{{ zaak.datum_start|date:"j F Y G:H" }}</td> + <td>{{ zaak.datum_wijziging|date:"j F Y G:H" }}</td> + <td>{{ zaak.opmerkingen }}</td> + <td><a href="/subjecten/{{ zaak.subject.id }}/">{{ zaak.subject }}</a></td> + </tr> + {% endfor %} + </table> + <div class="pagination"> + <span class="step-links"> + {% if page_obj.has_previous %} + <a href="?page={{ page_obj.previous_page_number }}">vorige</a>&nbsp;- + {% endif %} + + <span class="current"> + Pagina {{ page_obj.number }} van {{ paginator.num_pages }} + </span> + + {% if page_obj.has_next %} + &nbsp;- <a href="?page={{ page_obj.next_page_number }}">volgende</a> + {% endif %} + </span> + </div> +{% endblock content %} \ No newline at end of file diff --git a/urls.py b/urls.py index e0e121f..3a9aa9a 100644 --- a/urls.py +++ b/urls.py @@ -1,31 +1,34 @@ from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), + + # Zaken + (r'^zaken/', include("djangodemo.zaken.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), ) diff --git a/zaken/__init__.py b/zaken/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/zaken/admin.py b/zaken/admin.py new file mode 100644 index 0000000..9d07827 --- /dev/null +++ b/zaken/admin.py @@ -0,0 +1,12 @@ +from djangodemo.zaken.models import Zaak, Stap, Status, TypeStap, TypeStatus +from django.contrib import admin + +class ZaakAdmin(admin.ModelAdmin): + list_display = ('type_zaak', 'datum_start', 'datum_wijziging', 'subject') + pass + +admin.site.register(Zaak, ZaakAdmin) +admin.site.register(Stap) +admin.site.register(Status) +admin.site.register(TypeStap) +admin.site.register(TypeStatus) diff --git a/zaken/models.py b/zaken/models.py new file mode 100644 index 0000000..1d6e7e4 --- /dev/null +++ b/zaken/models.py @@ -0,0 +1,75 @@ +from django.db import models +from django import forms + +from djangodemo.subjecten.models import Subject + +# Models +ZAAK_TYPEN = ( + ('product_A', 'aanvraag product A'), + ('product_B', 'aanvraag product B'), + ('product_C', 'aanvraag product C'), + ) + +class Zaak(models.Model): + subject = models.ForeignKey(Subject) + datum_start = models.DateTimeField(auto_now_add = True) + datum_wijziging = models.DateTimeField(auto_now = True) + type_zaak = models.CharField(max_length = 10, choices = ZAAK_TYPEN) + opmerkingen = models.TextField() + + class Meta: + verbose_name_plural = "zaken" + + def __unicode__(self): + return "%s" % (self.type_zaak,) + +class TypeStap(models.Model): + type_zaak = models.CharField(max_length = 10, choices = ZAAK_TYPEN) + type_stap = models.CharField(max_length = 10) + omschrijving = models.CharField(max_length = 100) + + class Meta: + verbose_name_plural = "typestappen" + +class TypeStatus(models.Model): + type_zaak = models.CharField(max_length = 10, choices = ZAAK_TYPEN) + type_status = models.CharField(max_length = 10) + omschrijving = models.CharField(max_length = 100) + + class Meta: + verbose_name_plural = "typestatussen" + +class Stap(models.Model): + '''Voor het afhandelen van een zaak kunnen 1 of + meerdere stappen worden gezet. In welke volgorde + welke stap gezet wordt, wordt niet afgedwongen + door het model. Maar, wordt overgelaten aan een + proces buiten het model.''' + + zaak = models.ForeignKey(Zaak) + type_stap = models.ForeignKey(TypeStap) + datum_start = models.DateTimeField(auto_now_add = True) + datum_afgerond = models.DateTimeField(null = True, blank = True) + opmerkingen = models.TextField(null = True, blank = True) + + class Meta: + verbose_name_plural = "stappen" + +class Status(models.Model): + '''Bij het zetten van stappen voor het afhandelen + van een zaak kan een bepaalde status worden bereikt. + Bij welke stappen welke status wordt bereikt wordt + vastgelegd en gemanaged buiten het model om.''' + + zaak = models.ForeignKey(Zaak) + type_status = models.ForeignKey(TypeStatus) + datum = models.DateTimeField(auto_now_add = True) + + class Meta: + verbose_name_plural = "statussen" + +# Forms +class NewZaakForSubjectForm(forms.Form): + type_zaak = forms.ChoiceField(label="Type zaak", choices = ZAAK_TYPEN) + opmerkingen = forms.CharField(label="Opmerkingen", widget=forms.Textarea) + diff --git a/zaken/urls.py b/zaken/urls.py new file mode 100644 index 0000000..c16a811 --- /dev/null +++ b/zaken/urls.py @@ -0,0 +1,25 @@ +from django.conf.urls.defaults import * + +from djangodemo.zaken.models import Zaak + +# create/update/delete van zaken +# nieuwe zaak wordt aangemaakt via /subjecten/{{ id }}/zaken/new/ +urlpatterns = patterns('djangodemo.zaken.views', + (r'^(?P<zaak_id>\d+)/(edit|wijzig)/$', 'edit'), +) + +# list/detail van zaken +zaken = Zaak.objects.select_related().all() + +urlpatterns += patterns('django.views.generic.list_detail', + (r'^$', 'object_list', { + 'queryset': zaken, + 'template_name': 'zaken/index.html', + 'template_object_name': 'zaak', + 'paginate_by': 25}), + (r'^(?P<object_id>\d+)/$', 'object_detail', { + 'queryset': zaken, + 'template_name': 'zaken/detail.html', + 'template_object_name': 'zaak'}), +) + diff --git a/zaken/views.py b/zaken/views.py new file mode 100644 index 0000000..3231ad4 --- /dev/null +++ b/zaken/views.py @@ -0,0 +1,27 @@ +from django.shortcuts import render_to_response +from django.shortcuts import get_object_or_404 +from django.http import HttpResponseRedirect + +from djangodemo.zaken.models import Zaak, NewZaakForSubjectForm + +# vooralsnog leeg... ik kan tot nu toe alles met generic views doen! Zie urls.py + +def edit(request, zaak_id): + '''Edit existing zaak. You are not allowed to change subject + attributes for an existing zaak.''' + + # I am reusing NewZaakForSubjectForm because it contains the fields + # you are allowed to edit. + + zaak = get_object_or_404(Zaak, pk = zaak_id) + + if request.method == "POST": + form = NewZaakForSubjectForm(request.POST) #prefilled form from POST data + if form.is_valid(): + for k,v in form.cleaned_data.iteritems(): + setattr(zaak, k, v) + zaak.save() + return HttpResponseRedirect("/subjecten/%s/zaken/" % zaak.subject.pk) + else: + form = NewZaakForSubjectForm(initial={'type_zaak': zaak.type_zaak, 'opmerkingen': zaak.opmerkingen}) #empty form + return render_to_response('zaken/edit_zaak.html', {'form': form, 'zaak': zaak})
berry/Django-demo
b6e6fdd642e86777dc58f71274207d2fe084b65c
Some minor improvements. Plus a paragraph in README about the amout of code I had to write.
diff --git a/README.markdown b/README.markdown index 276dd41..78c77a5 100644 --- a/README.markdown +++ b/README.markdown @@ -302,529 +302,541 @@ Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: compass -w We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. Screen.sass ziet er nu als volgt uit: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") body +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. [28 feb 2010: bug opgelost. De index.html pagina in de hoofddirectory van het project was opgeslagen als UTF-8 zonder BOM, terwijl alle andere pagina's in UTF-8 met BOM waren opgeslagen. Index.html ook in UTF-8 met BOM opgeslagen en toen zag de startpagina er wel goed uit.] ## CSS Debug grid In Blueprint kun je ook een debug grid aanzetten. Dit grid geeft je visuele aanwijzingen over de verdeling van de content over de kolommen van het grid. Wijzig de urls.py in de hoofddirectory van het project naar: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), ) We hebben een url pad toegevoegd voor images. We dienen de directory waarnaar verwezen wordt ook aan te maken. Vanuit de hoofddirectory van het project voer uit: mkdir static/images cp static/css/djangodemo/images/* ./static/images/ We hebben ook de plaatjes van de Compass directory naar de static/images gekopieerd. Nu kunnen we in de .sass bestanden +blueprint-debug en +showgrid toevoegen aan het bestand screen.sass: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") +blueprint-debug body // Uncomment next line to make the debug grid visible //+showgrid +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" Het +showgrid commando kun je nu aan en uitzetten. Zet je +showgrid aan dan wordt op de website een plaatje getoond met daarin de kolommen aangegeven. ## Even terugkijken... We hebben nu een complete, functionele, werkende en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. Dit vormt het einde van onze eerste iteratie. Deze versie is heeft de tag v0.1 gekregen in Github. Een ruwe schets van onze Mona Lisa is uitgewerkt. We kunnen deze schets nu al aan onze klant of eindgebruikers laten zien. Sterker nog onze eindgebruikers zouden nu al mee aan het werk kunnen gaan met de website. Bijv. door de cliënten database te gaan vullen. Hoewel de website zelf nog maar erg weinig functionaliteit biedt. Maar, als eindgebruiker zou men nu al iets kunnen gaan zeggen over de layout of bijv. de gegevens die men mist bij een cliënt. En dat al na een klein uurtje werk. Moet je nagaan wat je na een dag werken in overleg met je eindgebruikers al bereikt zou kunnen hebben. Plus dat deze versie van de website de basis vormt voor de rest van onze ontwikkelingen. Hieronder volgen, minder uitgebreid, nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op deze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. Onderaan dit document vindt je ook een aantal referenties en links naar websites met meer informatie over Django, Compass, etc. ## Formulieren We gaan formulieren toevoegen aan de website. Django ondersteunt het maken van formulieren goed. Zo kun je automatisch formulieren uit modellen genereren. Maar, je blijft geheel vrij in de opmaak van het formulier. Een krachtig functionaliteit is dat je zelf zogenaamde validators kan schrijven waarmee je de ingevoerde data kan valideren. Allereerst definieren we aantal urls in subjecten/urls.py: (r'^(?P<subject_id> \d+)/edit/$', 'edit'), (r'^(?P<subject_id>\d+)/wijzig/$', 'edit'), (r'^nieuw/$', 'new'), (r'^new/$', 'new'), Voor het voorbeeld heb ik zowel Nederlands-talige en Engels-talige urls voor het wijzigen van bestaande cliënten en voor het toevoegen van nieuwe cliënten toegevoegd. De urls verwijzen naar een tweetal views in subjecten/views.py: 'edit' en 'new'. def new(request): '''Show form to add new subject''' if request.method == "POST": form = SubjectForm(request.POST) #prefilled form from POST data if form.is_valid(): new_subject = form.save() return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) else: form = SubjectForm() #empty form return render_to_response('subjecten/new_subject.html', {'form': form}) def edit(request, subject_id = None): '''Show form to change an existing subject''' if request.method == "POST": subject = Subject.objects.get(pk = subject_id) form = SubjectForm(request.POST, instance = subject) if form.is_valid(): new_subject = form.save() return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) else: subject = Subject.objects.get(pk = subject_id) form = SubjectForm(instance = subject) return render_to_response('subjecten/edit_subject.html', {'form': form, 'subject': subject}) De structuur van beide functies is gelijk. Je zou beide functies zelfs in één functie kunnen zetten. Dat is een kwestie van smaak. In de functie wordt allereerst gekeken of de request een POST of een GET is. Bij een GET wordt simpelweg een leeg formulier gemaakt of wordt, bij edit, het formulier voorgevuld met de data van de cliënt die we aan het bekijken zijn. Om een cliënt te kunnen wijzigen die je dus eerst een cliënt geselecteerd te hebben. Bij een POST vullen we het formulier met de data uit de POST. Middels `form.is_valid()` worden alle data validaties (de `clean()` functies) op alle invoervelden uitgevoerd. Treden er geen validatiefouten op dan kunnen we het formulier opslaan en redirecten we de gebruiker naar de cliënten pagina. Treden er wel validatiefouten op dan wordt de form mét de validatiefouten opnieuw aan de gebruiker getoond zodat de gebruiker de fouten kan herstellen. Het formulier `SubjectForm` heb ik gedefinieerd in subjecten/models.py. De formulier definities kun je ook in een apart bestand zetten. Ook dat is een kwestie van smaak en keuze. In subjecten/models.py had ik in eerste instantie het volgende toegevoegd. from django import forms # Forms class SubjectForm(forms.ModelForm): class Meta: model = Subject Middels ModelForm wordt een formulier aangemaakt op basis van een model. Dit is een hele snelle manier om een formulier te definiëren. En dit is voldoende voor een werkend formulier. Voor de verschillende invoervelden worden default DataFields gebruikt die default validaties uitvoeren. Zo wordt een e-mailadres default gevalideerd. Maar, al snel krijg je de behoeft aan aangepaste validaties. Als voorbeeld heb ik een validatie geschreven voor Nederlandse postcodes. En om te laten zien hoe je overerving kan gebruiken om validaties uit te breiden heb ik ook een validatie geschreven voor Amsterdamse postcodes. Het formulier met de validaties ziet er in subjecten/models.py dan zo uit: import re from django import forms # Form validators class DutchPostcodeField(forms.Field): def clean(self, value): '''Check that input is a valid Dutch postcode''' m = re.match(r'^([0-9]{4})\s?([a-zA-Z]{2}$)', value) # pattern: 1234 AA if not m or len(m.groups()) != 2: raise forms.ValidationError('Een Nederlandse postcode ziet er als volgt uit: 1234 AA') return "%s %s" % (m.groups()[0], m.groups()[1].upper()) class AmsterdamPostcodeField(DutchPostcodeField): def clean(self, value): '''Check that input is a valid Dutch postcode and check that Dutch postcode is within the Amsterdam postcode ranges. ''' value = super(AmsterdamPostcodeField, self).clean(value) n = int(value[0:4]) if not(1000 <= n <= 1099) and not(1100 <= n <= 1108): # postcode not in Amsterdam ranges raise forms.ValidationError('Voer een Amsterdamse postcode in.') return value # Forms class SubjectForm(forms.ModelForm): woonadres_postcode = AmsterdamPostcodeField() correspondentie_postcode = DutchPostcodeField() class Meta: model = Subject In `DutchPostcodeField` wordt een dataveld gedefinieerd met een eigen validatie functie. Validaties vinden in Django plaats in de `clean()` functie. Door je eigen `clean()` functie te schrijven, schrijf je dus je eigen validatie regels. In `DutchPostcodeField` kijken we met behulp van een reguliere expressie of het patroon van de input voldoet aan het patroon van een Nederlandse postcode. Voldoet de input niet dan volgt er een formulier validatiefout die uiteindelijk aan de gebruiker wordt getoond. De uitvoer van de `clean()` functie is een, in dit geval, een opgeschoonde postcode waarvan de letter ook in bovenkast gezet zijn. Postcodes worden hierdoor op een uniforme manier in de database opgeslagen. Het nieuwe veldtype `AmsterdamPostcodeField` erft over van `DutchPostcodeField`. Een Amsterdamse postcode is tenslotte ook een Nederlandse postcode. Middels de functie `super` roepen we dan ook allereerst de validatiefunctie aan van `DutchPostcodeField`. Van de opgeschoonde postcode controleren we of de eerste 4 cijfers van de postcodes vallen binnen de range van Amsterdamse postcodes. In `SubjectForm` wijzen we de twee aangepaste postcode velden toe aan `woonadres_postcode` en `correspondentie_postcode`. Het woonadres behoort altijd in Amsterdam te liggen en een correspondentieadres postcode mag in heel Nederland voorkomen. Het automatische gegenereerde formulier hebben we dus alleen voor twee specifieke velden aangepast. -Tevens heb ik nog een beetje opmaak toegevoegd aan de formulieren. Zie tag v0.2 in de source code. +Tevens heb ik nog een beetje opmaak toegevoegd aan de formulieren. Zie tag v0.2 in de source code. Op Github kun je mooi de verschillen bekijken tussen v0.2 en v0.1 middels de url `http://github.com/berry/Django-demo/compare/v0.1...v0.2`. + +## Hoeveelheid source code + +Als we kijken naar de hoeveelheid code die ik zelf heb moeten intikken om de functionaliteit te realiseren dan ziet dat er als volgt uit: + +Voor versie v0.2 van deze demo: + +* 110 regels code (de subjecten/*.py bestanden) +* 6 html-templates +* 1 compass bestand van 45 regels + +Lege regels in de source code heb ik gewoon meegeteld. Ik heb m.a.w. gewoon naar het aantal regels in Textmate gekeken. Ik heb geen vergelijkingsmateriaal met andere webframeworks of platformen. Maar, de hoeveelheid source code komt op mij over als overzichtelijk en behapbaar. ## Referenties * De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. * De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. * Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. * Compass bouwt voort op [Sass](http://sass-lang.com/about.html). * Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). * Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. * Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file diff --git a/djangodemo_db b/djangodemo_db index ff97b07..4730498 100644 Binary files a/djangodemo_db and b/djangodemo_db differ diff --git a/subjecten/models.py b/subjecten/models.py index a80f3d7..95988ad 100644 --- a/subjecten/models.py +++ b/subjecten/models.py @@ -1,59 +1,60 @@ import re from django.db import models from django import forms +# Models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() geboortedatum = models.DateField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) # Form validators class DutchPostcodeField(forms.Field): def clean(self, value): '''Check that input is a valid Dutch postcode''' m = re.match(r'^([0-9]{4})\s?([a-zA-Z]{2}$)', value) # pattern: 1234 AA if not m or len(m.groups()) != 2: raise forms.ValidationError('Een Nederlandse postcode ziet er als volgt uit: 1234 AA') return "%s %s" % (m.groups()[0], m.groups()[1].upper()) class AmsterdamPostcodeField(DutchPostcodeField): def clean(self, value): '''Check that input is a valid Dutch postcode and check that Dutch postcode is within the Amsterdam postcode ranges. ''' value = super(AmsterdamPostcodeField, self).clean(value) n = int(value[0:4]) if not(1000 <= n <= 1099) and not(1100 <= n <= 1108): # postcode not in Amsterdam ranges raise forms.ValidationError('Voer een Amsterdamse postcode in.') return value # Forms class SubjectForm(forms.ModelForm): woonadres_postcode = AmsterdamPostcodeField() correspondentie_postcode = DutchPostcodeField() class Meta: model = Subject \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html index a7f587f..b26efb2 100644 --- a/templates/subjecten/index.html +++ b/templates/subjecten/index.html @@ -1,21 +1,27 @@ {% extends "base.html" %} +{% load subjecten_extras %} + {% block content %} <h2>Lijst van cliënten</h2> <ul class="commandmenu"> <li>Acties:</li> <li><a href="/subjecten/new/">Cliënt opvoeren</a></li> </ul> <table> <tr> <th>Naam</th> + <th>Burgerservicenummer</th> + <th>Postcode</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> - <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> + <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a> ({{ subject.geboortedatum|leeftijd }} jaar)</td> + <td>{{ subject.bsn}}</td> + <td>{{ subject.woonadres_postcode }}</td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} \ No newline at end of file
berry/Django-demo
2ec8d4d117054b00b77d233bdd0127fae2e64132
Forms for adding and changing clients added. Forms also have some custom validators.
diff --git a/README.markdown b/README.markdown index 8ece7c5..276dd41 100644 --- a/README.markdown +++ b/README.markdown @@ -1,729 +1,830 @@  # Django & Compass gebruiken als een User Interaction Design tool * By: Berry Groenendijk * Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Licentie/License **TODO** - licentiemodel bepalen. Vooralsnog ligt het copyright volledig bij de auteur en eigenaar van deze github repository. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen realiseerde ik mij het volgende. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Het voordeel van een klikbare, functionele site is dat je daarmee gemakkelijker kan communiceren met eindgebruikers en bijvoorbeeld usability studies kan uitvoeren. Voor veel eindgebruikers is conceptueel denken heel lastig. En toch vragen we van gebruikers omdat te doen en vragen we zelfs wat er ontbreekt aan het concept en wat er beter aan kan. Het is niet gek dat we dan niet de juiste dingen te horen krijgen. Bouw snel, continu, release vaak en laat je gebruiker vaak naar het resultaat kijken. En wees niet bang om dingen weg te gooien en opnieuw te doen. Je gooit veel gemakkelijker iets weg waar je slechts weinig tijd aan hebt besteedt dan wanneer je er dagen of weken mee bezig bent geweest. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. -* [Python 2.5](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. +* [Python 2.5](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. -* [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. Ik heb Django-1.1.1 uitgepakt en de directory Django-1.1.1 in mijn eigen homedirectory "/Users/berry" geplaatst. +* [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. Ik heb Django-1.1.1 uitgepakt en de directory Django-1.1.1 in mijn eigen homedirectory "/Users/berry" geplaatst. * [Compass](http://wiki.github.com/chriseppstein/compass/getting-started). Voor Compass hebben we Ruby nodig. Op Mac OS X staat Ruby al. Vanaf de command prompt voer de volgende commando's uit: sudo gem update --system sudo gem install compass * Als database gebruiken we SQLite. En SQLite wordt meegeleverd met Python 2.5. Dus dat is ook al op de computer aanwezig. Dat is alles om aan de slag te kunnen. ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: compass -w We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. Screen.sass ziet er nu als volgt uit: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") body +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. [28 feb 2010: bug opgelost. De index.html pagina in de hoofddirectory van het project was opgeslagen als UTF-8 zonder BOM, terwijl alle andere pagina's in UTF-8 met BOM waren opgeslagen. Index.html ook in UTF-8 met BOM opgeslagen en toen zag de startpagina er wel goed uit.] ## CSS Debug grid In Blueprint kun je ook een debug grid aanzetten. Dit grid geeft je visuele aanwijzingen over de verdeling van de content over de kolommen van het grid. Wijzig de urls.py in de hoofddirectory van het project naar: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), ) We hebben een url pad toegevoegd voor images. We dienen de directory waarnaar verwezen wordt ook aan te maken. Vanuit de hoofddirectory van het project voer uit: mkdir static/images cp static/css/djangodemo/images/* ./static/images/ We hebben ook de plaatjes van de Compass directory naar de static/images gekopieerd. Nu kunnen we in de .sass bestanden +blueprint-debug en +showgrid toevoegen aan het bestand screen.sass: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") +blueprint-debug body // Uncomment next line to make the debug grid visible //+showgrid +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" Het +showgrid commando kun je nu aan en uitzetten. Zet je +showgrid aan dan wordt op de website een plaatje getoond met daarin de kolommen aangegeven. ## Even terugkijken... We hebben nu een complete, functionele, werkende en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. Dit vormt het einde van onze eerste iteratie. Deze versie is heeft de tag v0.1 gekregen in Github. Een ruwe schets van onze Mona Lisa is uitgewerkt. We kunnen deze schets nu al aan onze klant of eindgebruikers laten zien. Sterker nog onze eindgebruikers zouden nu al mee aan het werk kunnen gaan met de website. Bijv. door de cliënten database te gaan vullen. Hoewel de website zelf nog maar erg weinig functionaliteit biedt. Maar, als eindgebruiker zou men nu al iets kunnen gaan zeggen over de layout of bijv. de gegevens die men mist bij een cliënt. En dat al na een klein uurtje werk. Moet je nagaan wat je na een dag werken in overleg met je eindgebruikers al bereikt zou kunnen hebben. Plus dat deze versie van de website de basis vormt voor de rest van onze ontwikkelingen. -Hieronder volgen, minder uitgebreidt, nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op deze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. +Hieronder volgen, minder uitgebreid, nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op deze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. Onderaan dit document vindt je ook een aantal referenties en links naar websites met meer informatie over Django, Compass, etc. +## Formulieren + +We gaan formulieren toevoegen aan de website. Django ondersteunt het maken van formulieren goed. Zo kun je automatisch formulieren uit modellen genereren. Maar, je blijft geheel vrij in de opmaak van het formulier. Een krachtig functionaliteit is dat je zelf zogenaamde validators kan schrijven waarmee je de ingevoerde data kan valideren. + +Allereerst definieren we aantal urls in subjecten/urls.py: + + (r'^(?P<subject_id> \d+)/edit/$', 'edit'), + (r'^(?P<subject_id>\d+)/wijzig/$', 'edit'), + (r'^nieuw/$', 'new'), + (r'^new/$', 'new'), + +Voor het voorbeeld heb ik zowel Nederlands-talige en Engels-talige urls voor het wijzigen van bestaande cliënten en voor het toevoegen van nieuwe cliënten toegevoegd. De urls verwijzen naar een tweetal views in subjecten/views.py: 'edit' en 'new'. + + def new(request): + '''Show form to add new subject''' + + if request.method == "POST": + form = SubjectForm(request.POST) #prefilled form from POST data + if form.is_valid(): + new_subject = form.save() + return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) + else: + form = SubjectForm() #empty form + return render_to_response('subjecten/new_subject.html', {'form': form}) + + def edit(request, subject_id = None): + '''Show form to change an existing subject''' + + if request.method == "POST": + subject = Subject.objects.get(pk = subject_id) + form = SubjectForm(request.POST, instance = subject) + if form.is_valid(): + new_subject = form.save() + return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) + else: + subject = Subject.objects.get(pk = subject_id) + form = SubjectForm(instance = subject) + return render_to_response('subjecten/edit_subject.html', {'form': form, 'subject': subject}) + +De structuur van beide functies is gelijk. Je zou beide functies zelfs in één functie kunnen zetten. Dat is een kwestie van smaak. In de functie wordt allereerst gekeken of de request een POST of een GET is. Bij een GET wordt simpelweg een leeg formulier gemaakt of wordt, bij edit, het formulier voorgevuld met de data van de cliënt die we aan het bekijken zijn. Om een cliënt te kunnen wijzigen die je dus eerst een cliënt geselecteerd te hebben. + +Bij een POST vullen we het formulier met de data uit de POST. Middels `form.is_valid()` worden alle data validaties (de `clean()` functies) op alle invoervelden uitgevoerd. Treden er geen validatiefouten op dan kunnen we het formulier opslaan en redirecten we de gebruiker naar de cliënten pagina. Treden er wel validatiefouten op dan wordt de form mét de validatiefouten opnieuw aan de gebruiker getoond zodat de gebruiker de fouten kan herstellen. + +Het formulier `SubjectForm` heb ik gedefinieerd in subjecten/models.py. De formulier definities kun je ook in een apart bestand zetten. Ook dat is een kwestie van smaak en keuze. In subjecten/models.py had ik in eerste instantie het volgende toegevoegd. + + from django import forms + + # Forms + class SubjectForm(forms.ModelForm): + + class Meta: + model = Subject + +Middels ModelForm wordt een formulier aangemaakt op basis van een model. Dit is een hele snelle manier om een formulier te definiëren. En dit is voldoende voor een werkend formulier. Voor de verschillende invoervelden worden default DataFields gebruikt die default validaties uitvoeren. Zo wordt een e-mailadres default gevalideerd. + +Maar, al snel krijg je de behoeft aan aangepaste validaties. Als voorbeeld heb ik een validatie geschreven voor Nederlandse postcodes. En om te laten zien hoe je overerving kan gebruiken om validaties uit te breiden heb ik ook een validatie geschreven voor Amsterdamse postcodes. Het formulier met de validaties ziet er in subjecten/models.py dan zo uit: + + import re + + from django import forms + + # Form validators + class DutchPostcodeField(forms.Field): + def clean(self, value): + '''Check that input is a valid Dutch postcode''' + m = re.match(r'^([0-9]{4})\s?([a-zA-Z]{2}$)', value) # pattern: 1234 AA + if not m or len(m.groups()) != 2: + raise forms.ValidationError('Een Nederlandse postcode ziet er als volgt uit: 1234 AA') + return "%s %s" % (m.groups()[0], m.groups()[1].upper()) + + class AmsterdamPostcodeField(DutchPostcodeField): + def clean(self, value): + '''Check that input is a valid Dutch postcode and + check that Dutch postcode is within the Amsterdam + postcode ranges. + ''' + value = super(AmsterdamPostcodeField, self).clean(value) + n = int(value[0:4]) + if not(1000 <= n <= 1099) and not(1100 <= n <= 1108): + # postcode not in Amsterdam ranges + raise forms.ValidationError('Voer een Amsterdamse postcode in.') + return value + + # Forms + class SubjectForm(forms.ModelForm): + woonadres_postcode = AmsterdamPostcodeField() + correspondentie_postcode = DutchPostcodeField() + + class Meta: + model = Subject + +In `DutchPostcodeField` wordt een dataveld gedefinieerd met een eigen validatie functie. Validaties vinden in Django plaats in de `clean()` functie. Door je eigen `clean()` functie te schrijven, schrijf je dus je eigen validatie regels. + +In `DutchPostcodeField` kijken we met behulp van een reguliere expressie of het patroon van de input voldoet aan het patroon van een Nederlandse postcode. Voldoet de input niet dan volgt er een formulier validatiefout die uiteindelijk aan de gebruiker wordt getoond. De uitvoer van de `clean()` functie is een, in dit geval, een opgeschoonde postcode waarvan de letter ook in bovenkast gezet zijn. Postcodes worden hierdoor op een uniforme manier in de database opgeslagen. + +Het nieuwe veldtype `AmsterdamPostcodeField` erft over van `DutchPostcodeField`. Een Amsterdamse postcode is tenslotte ook een Nederlandse postcode. Middels de functie `super` roepen we dan ook allereerst de validatiefunctie aan van `DutchPostcodeField`. Van de opgeschoonde postcode controleren we of de eerste 4 cijfers van de postcodes vallen binnen de range van Amsterdamse postcodes. + +In `SubjectForm` wijzen we de twee aangepaste postcode velden toe aan `woonadres_postcode` en `correspondentie_postcode`. Het woonadres behoort altijd in Amsterdam te liggen en een correspondentieadres postcode mag in heel Nederland voorkomen. Het automatische gegenereerde formulier hebben we dus alleen voor twee specifieke velden aangepast. + +Tevens heb ik nog een beetje opmaak toegevoegd aan de formulieren. Zie tag v0.2 in de source code. + ## Referenties * De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. * De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. * Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. * Compass bouwt voort op [Sass](http://sass-lang.com/about.html). * Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). * Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. * Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file diff --git a/djangodemo_db b/djangodemo_db index cc3db4e..ff97b07 100644 Binary files a/djangodemo_db and b/djangodemo_db differ diff --git a/settings.py b/settings.py index 83f8823..62f8d24 100644 --- a/settings.py +++ b/settings.py @@ -1,82 +1,82 @@ # Django settings for djangodemo project. DEBUG = True TEMPLATE_DEBUG = DEBUG ADMINS = ( # ('Your Name', '[email protected]'), ) MANAGERS = ADMINS DATABASE_ENGINE = 'django.db.backends.sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'. DATABASE_NAME = '/Users/berry/git/djangodemo/djangodemo_db' # Or path to database file if using sqlite3. DATABASE_USER = '' # Not used with sqlite3. DATABASE_PASSWORD = '' # Not used with sqlite3. DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3. DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3. # Local time zone for this installation. Choices can be found here: # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name # although not all choices may be available on all operating systems. # If running in a Windows environment this must be set to the same as your # system time zone. TIME_ZONE = 'America/Chicago' # Language code for this installation. All choices can be found here: # http://www.i18nguy.com/unicode/language-identifiers.html -LANGUAGE_CODE = 'en-us' +LANGUAGE_CODE = 'nl-nl' SITE_ID = 1 # If you set this to False, Django will make some optimizations so as not # to load the internationalization machinery. USE_I18N = True # Absolute path to the directory that holds media. # Example: "/home/media/media.lawrence.com/" MEDIA_ROOT = '' # URL that handles the media served from MEDIA_ROOT. Make sure to use a # trailing slash if there is a path component (optional in other cases). # Examples: "http://media.lawrence.com", "http://example.com/media/" MEDIA_URL = '' # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a # trailing slash. # Examples: "http://foo.com/media/", "/media/". ADMIN_MEDIA_PREFIX = '/media/' # Make this unique, and don't share it with anybody. SECRET_KEY = 'u*onq-80ifbru9^h-y)n$l^rd_yr(#low#!lh+m%x)jsgzywzr' # List of callables that know how to import templates from various sources. TEMPLATE_LOADERS = ( 'django.template.loaders.filesystem.load_template_source', 'django.template.loaders.app_directories.load_template_source', # 'django.template.loaders.eggs.load_template_source', ) MIDDLEWARE_CLASSES = ( 'django.middleware.common.CommonMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', ) ROOT_URLCONF = 'djangodemo.urls' TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) diff --git a/static/css/djangodemo/src/screen.sass b/static/css/djangodemo/src/screen.sass index cb440fc..a28af96 100644 --- a/static/css/djangodemo/src/screen.sass +++ b/static/css/djangodemo/src/screen.sass @@ -1,35 +1,46 @@ // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") -+blueprint-debug body - // Uncomment next line to make the debug grid visible + // Uncomment next two lines to make the debug grid visible + //+blueprint-debug //+showgrid - +container + !sidebar_columns = floor(!blueprint_grid_columns / 4) + .container + +container #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header - +column(!blueprint_grid_columns) + +column(!blueprint_grid_columns, true) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) - + .commandmenu + +horizontal-list(5px) + margin-bottom = 1em + +form + +blueprint-inline-form + table +table-scaffolding th background-color = #eee text-align = "left" - + .label + float = "left" + width = 130px + diff --git a/static/css/djangodemo/stylesheets/screen.css b/static/css/djangodemo/stylesheets/screen.css index ef1dac3..3c271e0 100644 --- a/static/css/djangodemo/stylesheets/screen.css +++ b/static/css/djangodemo/stylesheets/screen.css @@ -1,110 +1,117 @@ html, body { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, pre, a, abbr, acronym, address, code, del, dfn, em, img, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, caption, tbody, tfoot, thead, tr { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } blockquote, q { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; quotes: "" ""; } blockquote:before, q:before, blockquote:after, q:after { content: ""; } th, td, caption { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; text-align: left; font-weight: normal; vertical-align: middle; } table { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; border-collapse: separate; border-spacing: 0; vertical-align: middle; } a img { border: none; } body { line-height: 1.5; font-family: Helvetica Neue, Arial, Helvetica, sans-serif; color: #333333; font-size: 75%; } h1 { font-weight: normal; color: #222222; font-size: 3em; line-height: 1; margin-bottom: 0.5em; } h1 img { margin: 0; } h2 { font-weight: normal; color: #222222; font-size: 2em; margin-bottom: 0.75em; } h3 { font-weight: normal; color: #222222; font-size: 1.5em; line-height: 1; margin-bottom: 1em; } h4 { font-weight: normal; color: #222222; font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; } h5 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; margin-bottom: 1.5em; } h6 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; } h2 img, h3 img, h4 img, h5 img, h6 img { margin: 0; } p { margin: 0 0 1.5em; } p img.left { display: inline; float: left; margin: 1.5em 1.5em 1.5em 0; padding: 0; } p img.right { display: inline; float: right; margin: 1.5em 0 1.5em 1.5em; padding: 0; } a { text-decoration: underline; color: #000099; } a:visited { color: #000066; } a:focus { color: black; } a:hover { color: black; } a:active { color: #cc0099; } blockquote { margin: 1.5em; color: #666; font-style: italic; } strong { font-weight: bold; } em { font-style: italic; } dfn { font-style: italic; font-weight: bold; } sup, sub { line-height: 0; } abbr, acronym { border-bottom: 1px dotted #666; } address { margin: 0 0 1.5em; font-style: italic; } del { color: #666; } pre { margin: 1.5em 0; white-space: pre; } pre, code, tt { font: 1em 'andale mono', 'lucida console', monospace; line-height: 1.5; } li ul, li ol { margin: 0 1.5em; } ul { margin: 0 1.5em 1.5em 1.5em; list-style-type: disc; } ol { margin: 0 1.5em 1.5em 1.5em; list-style-type: decimal; } dl { margin: 0 0 1.5em 0; } dl dt { font-weight: bold; } dd { margin-left: 1.5em; } table { margin-bottom: 1.4em; width: 100%; } th { font-weight: bold; } thead th { background: #c3d9ff; } th, td, caption { padding: 4px 10px 4px 5px; } tr.even td { background: #e5ecf9; } tfoot { font-style: italic; } caption { background: #eee; } .quiet { color: #666666; } .loud { color: #111111; } -.showgrid { background: url('/images/grid.png?1267263512'); } - -body { width: 950px; margin: 0 auto; overflow: hidden; display: inline-block; } -body { display: block; } +body .container { width: 950px; margin: 0 auto; overflow: hidden; display: inline-block; } +body .container { display: block; } body #menu { display: inline; float: left; margin-right: 10px; width: 230px; } * html body #menu { overflow-x: hidden; } body #menu li { list-style-type: none; margin-left: 0px; } body #content { display: inline; float: left; margin-right: 0; width: 710px; } * html body #content { overflow-x: hidden; } -body #footer, body #header { display: inline; float: left; margin-right: 10px; width: 950px; } +body #footer, body #header { display: inline; float: left; margin-right: 0; width: 950px; } * html body #footer, * html body #header { overflow-x: hidden; } body #footer { background-color: #eeeeee; margin-top: 1em; margin: 0; padding: 0; border: 0; outline: 0; overflow: hidden; display: inline-block; } body #footer { display: block; } body #footer li { list-style-type: none; margin-left: 0px; white-space: nowrap; display: inline; float: left; padding-left: 5px; padding-right: 5px; } body #footer li.first { padding-left: 0px; } body #footer li.last { padding-right: 0px; } +body .commandmenu { margin: 0; padding: 0; border: 0; outline: 0; overflow: hidden; display: inline-block; margin-bottom: 1em; } +body .commandmenu { display: block; } +body .commandmenu li { list-style-type: none; margin-left: 0px; white-space: nowrap; display: inline; float: left; padding-left: 5px; padding-right: 5px; } +body .commandmenu li.first { padding-left: 0px; } +body .commandmenu li.last { padding-right: 0px; } + +form { line-height: 3; } +form p { margin-bottom: 0; } table th { text-align: center; font-weight: bold; } table td, table th { padding: 2px; } table td.numeric, table th.numeric { text-align: right; } table th { background-color: #eeeeee; text-align: left; } +table .label { float: left; width: 130px; } diff --git a/subjecten/models.py b/subjecten/models.py index 1387410..a80f3d7 100644 --- a/subjecten/models.py +++ b/subjecten/models.py @@ -1,26 +1,59 @@ +import re + from django.db import models +from django import forms class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() geboortedatum = models.DateField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): - return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) \ No newline at end of file + return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) + +# Form validators +class DutchPostcodeField(forms.Field): + def clean(self, value): + '''Check that input is a valid Dutch postcode''' + m = re.match(r'^([0-9]{4})\s?([a-zA-Z]{2}$)', value) # pattern: 1234 AA + if not m or len(m.groups()) != 2: + raise forms.ValidationError('Een Nederlandse postcode ziet er als volgt uit: 1234 AA') + return "%s %s" % (m.groups()[0], m.groups()[1].upper()) + +class AmsterdamPostcodeField(DutchPostcodeField): + def clean(self, value): + '''Check that input is a valid Dutch postcode and + check that Dutch postcode is within the Amsterdam + postcode ranges. + ''' + value = super(AmsterdamPostcodeField, self).clean(value) + n = int(value[0:4]) + if not(1000 <= n <= 1099) and not(1100 <= n <= 1108): + # postcode not in Amsterdam ranges + raise forms.ValidationError('Voer een Amsterdamse postcode in.') + return value + +# Forms +class SubjectForm(forms.ModelForm): + woonadres_postcode = AmsterdamPostcodeField() + correspondentie_postcode = DutchPostcodeField() + + class Meta: + model = Subject \ No newline at end of file diff --git a/subjecten/urls.py b/subjecten/urls.py index c61eb7c..2f11e9c 100644 --- a/subjecten/urls.py +++ b/subjecten/urls.py @@ -1,6 +1,10 @@ from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), + (r'^(?P<subject_id>\d+)/edit/$', 'edit'), + (r'^(?P<subject_id>\d+)/wijzig/$', 'edit'), + (r'^nieuw/$', 'new'), + (r'^new/$', 'new'), ) \ No newline at end of file diff --git a/subjecten/views.py b/subjecten/views.py index 662671f..f565e2e 100644 --- a/subjecten/views.py +++ b/subjecten/views.py @@ -1,16 +1,42 @@ from django.shortcuts import render_to_response +from django.http import HttpResponseRedirect -from djangodemo.subjecten.models import Subject +from djangodemo.subjecten.models import Subject, SubjectForm def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) - \ No newline at end of file + +def new(request): + '''Show form to add new subject''' + + if request.method == "POST": + form = SubjectForm(request.POST) #prefilled form from POST data + if form.is_valid(): + new_subject = form.save() + return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) + else: + form = SubjectForm() #empty form + return render_to_response('subjecten/new_subject.html', {'form': form}) + +def edit(request, subject_id = None): + '''Show form to change an existing subject''' + + if request.method == "POST": + subject = Subject.objects.get(pk = subject_id) + form = SubjectForm(request.POST, instance = subject) + if form.is_valid(): + new_subject = form.save() + return HttpResponseRedirect("/subjecten/%s/" % new_subject.pk) + else: + subject = Subject.objects.get(pk = subject_id) + form = SubjectForm(instance = subject) + return render_to_response('subjecten/edit_subject.html', {'form': form, 'subject': subject}) \ No newline at end of file diff --git a/templates/base.html b/templates/base.html index 9e012f7..cb684ae 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,37 +1,39 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <title>Demo Django &amp; Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css"> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css"> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css"> <![endif]--> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head> <body> - <div id="header"> - <h1>Demo Zaakgericht Werken</h1> - <p>Alle gegevens die hier getoond worden zijn fictief en uit de duim gezogen. Elke overeenkomst met de werkelijkheid berust op toeval.</p> + <div class="container"> + <div id="header"> + <h1>Demo Zaakgericht Werken</h1> + <p>Alle gegevens die hier getoond worden zijn fictief en uit de duim gezogen. Elke overeenkomst met de werkelijkheid berust op toeval.</p> + </div> + <div id="menu"> + <h2>Menu</h2> + <ul> + <li><a href="/subjecten">Cliënten</a></li> + </ul> + </div> + <div id="content"> + {% block content %} + <p>-</p> + {% endblock %} + </div> + <div id="footer"> + <ul> + <li><a href="/">Home</a></li> + <li><a href="#">About</a></li> + <li><a href="#">Contact</a></li> + <li>&copy; 2010 - My Business</li> + </ul> + </div> </div> - <div id="menu"> - <h2>Menu</h2> - <ul> - <li><a href="/subjecten">Cliënten</a></li> - </ul> - </div> - <div id="content"> - {% block content %} - <p>-</p> - {% endblock %} - </div> - <div id="footer"> - <ul> - <li><a href="/">Home</a></li> - <li><a href="#">About</a></li> - <li><a href="#">Contact</a></li> - <li>&copy; 2010 - My Business</li> - </ul> - </div> </body> </html> \ No newline at end of file diff --git a/templates/subjecten/detail.html b/templates/subjecten/detail.html index 53c634b..07e6e50 100644 --- a/templates/subjecten/detail.html +++ b/templates/subjecten/detail.html @@ -1,50 +1,54 @@ {% extends "base.html" %} {% load subjecten_extras %} {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> + <ul class="commandmenu"> + <li>Acties:</li> + <li><a href="/subjecten/{{ subject.pk }}/edit/">Wijzig cliëntgegevens</a></li> + </ul> <table> <tr> <th>Details</th> </tr> <tr> <td>Burgerservicenummer: &nbsp;{{ subject.bsn }}</td> </tr> <tr> - <td>Geboortedatum: &nbsp;{{ subject.geboortedatum|date:"d M Y" }} ({{ subject.geboortedatum|leeftijd }} jaar)</td> + <td>Geboortedatum: &nbsp;{{ subject.geboortedatum|date:"j F Y" }} ({{ subject.geboortedatum|leeftijd }} jaar)</td> </tr> </table> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> - {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} + {{ subject.woonadres_postcode }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> - {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} + {{ subject.correspondentie_postcode }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> <table> <tr> <th>Contact</th> </tr> <tr> <td> e-mail: {{ subject.email }} </td> </tr> <tr> <td> telefoon: {{ subject.telefoonnummer }} </td> </tr> </table> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/edit_subject.html b/templates/subjecten/edit_subject.html new file mode 100644 index 0000000..dfe3836 --- /dev/null +++ b/templates/subjecten/edit_subject.html @@ -0,0 +1,95 @@ +{% extends "base.html" %} + +{% load subjecten_extras %} + +{% block content %} + <h2>Wijzig cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> + {{ form.errors }} + <form action="/subjecten/{{ subject.pk }}/edit/" method="post"> + <table> + <tr> + <th>Details</th> + </tr> + <tr> + <td> + <span class="label">Naam:</span> {{ form.voorletters}} {{ form.tussenvoegsels }} {{ form.achternaam }} + </td> + </tr> + <tr> + <td> + <span class="label">Burgerservicenummer: </span>{{ form.bsn }} + </td> + </tr> + <tr> + <td> + <span class="label">Geboortedatum:</span> {{ form.geboortedatum }} + </td> + </tr> + </table> + <table> + <tr> + <th>Woonadres</th> + <th>Correspondentieadres</th> + </tr> + <tr> + <td> + <span class="label">Straat:</span>{{ form.woonadres_straatnaam }} + </td> + <td> + <span class="label">Straat:</span>{{ form.correspondentie_straatnaam }} + </td> + <tr> + <td> + <span class="label">Huisnummer:</span>{{ form.woonadres_huisnummer }} + </td> + <td> + <span class="label">Huisnummer:</span>{{ form.correspondentie_huisnummer }} + </td> + </tr> + <tr> + <td> + <span class="label">Huisnr. toevoeging:</span> {{ form.woonadres_huisnummer_toevoeging }} + </td> + <td> + <span class="label">Huisnr. toevoeging:</span> {{ form.correspondentie_huisnummer_toevoeging }} + </td> + + </tr> + <tr> + <td> + <span class="label">Postcode:</span> {{ form.woonadres_postcode }} + </td> + <td> + <span class="label">Postcode:</span> {{ form.correspondentie_postcode }} + </td> + </tr> + <td> + <span class="label">Woonplaats:</span> {{ form.woonadres_woonplaats }} + </td> + <td> + <span class="label">Woonplaats:</span> {{ form.correspondentie_woonplaats }} + </td> + </tr> + </table> + <table> + <tr> + <th>Contact</th> + </tr> + <tr> + <td> + <span class="label">e-mail:</span> {{ form.email }} + </td> + </tr> + <tr> + <td> + <span class="label">telefoon:</span> {{ form.telefoonnummer }} + </td> + </tr> + + </table> + <a href="/subjecten/{{ subject.pk }}/"><input type="button" value="Annuleer" /></a> + <input type="submit" value="Bewaar" /> + </form> + + +{% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html index ff6e77b..a7f587f 100644 --- a/templates/subjecten/index.html +++ b/templates/subjecten/index.html @@ -1,17 +1,21 @@ {% extends "base.html" %} {% block content %} <h2>Lijst van cliënten</h2> + <ul class="commandmenu"> + <li>Acties:</li> + <li><a href="/subjecten/new/">Cliënt opvoeren</a></li> + </ul> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/new_subject.html b/templates/subjecten/new_subject.html new file mode 100644 index 0000000..0e730b2 --- /dev/null +++ b/templates/subjecten/new_subject.html @@ -0,0 +1,91 @@ +{% extends "base.html" %} + +{% block content %} + <h2>Nieuwe cliënt opvoeren</h2> + {{ form.errors }} + <form action="/subjecten/new/" method="post"> + <table> + <tr> + <th>Details</th> + </tr> + <tr> + <td> + <span class="label">Naam:</span> {{ form.voorletters}} {{ form.tussenvoegsels }} {{ form.achternaam }} + </td> + </tr> + <tr> + <td> + <span class="label">Burgerservicenummer: </span>{{ form.bsn }} + </td> + </tr> + <tr> + <td> + <span class="label">Geboortedatum:</span> {{ form.geboortedatum }} + </td> + </tr> + </table> + <table> + <tr> + <th>Woonadres</th> + <th>Correspondentieadres</th> + </tr> + <tr> + <td> + <span class="label">Straat:</span>{{ form.woonadres_straatnaam }} + </td> + <td> + <span class="label">Straat:</span>{{ form.correspondentie_straatnaam }} + </td> + <tr> + <td> + <span class="label">Huisnummer:</span>{{ form.woonadres_huisnummer }} + </td> + <td> + <span class="label">Huisnummer:</span>{{ form.correspondentie_huisnummer }} + </td> + </tr> + <tr> + <td> + <span class="label">Huisnr. toevoeging:</span> {{ form.woonadres_huisnummer_toevoeging }} + </td> + <td> + <span class="label">Huisnr. toevoeging:</span> {{ form.correspondentie_huisnummer_toevoeging }} + </td> + + </tr> + <tr> + <td> + <span class="label">Postcode:</span> {{ form.woonadres_postcode }} + </td> + <td> + <span class="label">Postcode:</span> {{ form.correspondentie_postcode }} + </td> + </tr> + <td> + <span class="label">Woonplaats:</span> {{ form.woonadres_woonplaats }} + </td> + <td> + <span class="label">Woonplaats:</span> {{ form.correspondentie_woonplaats }} + </td> + </tr> + </table> + <table> + <tr> + <th>Contact</th> + </tr> + <tr> + <td> + <span class="label">e-mail:</span> {{ form.email }} + </td> + </tr> + <tr> + <td> + <span class="label">telefoon:</span> {{ form.telefoonnummer }} + </td> + </tr> + + </table> + <a href="/subjecten/"><input type="button" value="Annuleer" /></a> + <input type="submit" value="Bewaar" /> + </form> +{% endblock content %} \ No newline at end of file
berry/Django-demo
e969cd67174dd820e038f64b5fb93e764af11dfb
Tagged this v0.1.
diff --git a/README.markdown b/README.markdown index 442c458..8ece7c5 100644 --- a/README.markdown +++ b/README.markdown @@ -105,625 +105,625 @@ Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manie python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: compass -w We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. Screen.sass ziet er nu als volgt uit: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") body +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. [28 feb 2010: bug opgelost. De index.html pagina in de hoofddirectory van het project was opgeslagen als UTF-8 zonder BOM, terwijl alle andere pagina's in UTF-8 met BOM waren opgeslagen. Index.html ook in UTF-8 met BOM opgeslagen en toen zag de startpagina er wel goed uit.] -## Even terugkijken... - -We hebben nu een complete, functionele, werkende en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. - -Dit vormt het einde van onze eerste iteratie. Een ruwe schets van onze Mona Lisa is uitgewerkt. We kunnen deze schets nu al aan onze klant of eindgebruikers laten zien. - -Sterker nog onze eindgebruikers zouden nu al mee aan het werk kunnen gaan met de website. Bijv. door de cliënten database te gaan vullen. Hoewel de website zelf nog maar erg weinig functionaliteit biedt. Maar, als eindgebruiker zou men nu al iets kunnen gaan zeggen over de layout of bijv. de gegevens die men mist bij een cliënt. En dat al na een klein uurtje werk. Moet je nagaan wat je na een dag werken in overleg met je eindgebruikers al bereikt zou kunnen hebben. - -Plus dat deze versie van de website de basis vormt voor de rest van onze ontwikkelingen. - -Hieronder volgen, minder uitgebreidt, nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op deze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. - -Onderaan dit document vindt je ook een aantal referenties en links naar websites met meer informatie over Django, Compass, etc. - ## CSS Debug grid In Blueprint kun je ook een debug grid aanzetten. Dit grid geeft je visuele aanwijzingen over de verdeling van de content over de kolommen van het grid. Wijzig de urls.py in de hoofddirectory van het project naar: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), ) We hebben een url pad toegevoegd voor images. We dienen de directory waarnaar verwezen wordt ook aan te maken. Vanuit de hoofddirectory van het project voer uit: mkdir static/images cp static/css/djangodemo/images/* ./static/images/ We hebben ook de plaatjes van de Compass directory naar de static/images gekopieerd. Nu kunnen we in de .sass bestanden +blueprint-debug en +showgrid toevoegen aan het bestand screen.sass: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") +blueprint-debug body // Uncomment next line to make the debug grid visible //+showgrid +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" Het +showgrid commando kun je nu aan en uitzetten. Zet je +showgrid aan dan wordt op de website een plaatje getoond met daarin de kolommen aangegeven. +## Even terugkijken... + +We hebben nu een complete, functionele, werkende en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. + +Dit vormt het einde van onze eerste iteratie. Deze versie is heeft de tag v0.1 gekregen in Github. Een ruwe schets van onze Mona Lisa is uitgewerkt. We kunnen deze schets nu al aan onze klant of eindgebruikers laten zien. + +Sterker nog onze eindgebruikers zouden nu al mee aan het werk kunnen gaan met de website. Bijv. door de cliënten database te gaan vullen. Hoewel de website zelf nog maar erg weinig functionaliteit biedt. Maar, als eindgebruiker zou men nu al iets kunnen gaan zeggen over de layout of bijv. de gegevens die men mist bij een cliënt. En dat al na een klein uurtje werk. Moet je nagaan wat je na een dag werken in overleg met je eindgebruikers al bereikt zou kunnen hebben. + +Plus dat deze versie van de website de basis vormt voor de rest van onze ontwikkelingen. + +Hieronder volgen, minder uitgebreidt, nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op deze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. + +Onderaan dit document vindt je ook een aantal referenties en links naar websites met meer informatie over Django, Compass, etc. + ## Referenties * De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. * De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. * Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. * Compass bouwt voort op [Sass](http://sass-lang.com/about.html). * Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). * Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. * Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file
berry/Django-demo
28d579185d88aed15a5f583a44eb9cf11133277c
Improved the calculation of age of a person.
diff --git a/README.markdown b/README.markdown index 9ac0a66..442c458 100644 --- a/README.markdown +++ b/README.markdown @@ -115,615 +115,615 @@ Resultaat: Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> <th>Woonadres</th> <th>Correspondentieadres</th> </tr> <tr> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: compass -w We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. Screen.sass ziet er nu als volgt uit: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") body +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. [28 feb 2010: bug opgelost. De index.html pagina in de hoofddirectory van het project was opgeslagen als UTF-8 zonder BOM, terwijl alle andere pagina's in UTF-8 met BOM waren opgeslagen. Index.html ook in UTF-8 met BOM opgeslagen en toen zag de startpagina er wel goed uit.] ## Even terugkijken... We hebben nu een complete, functionele, werkende en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. Dit vormt het einde van onze eerste iteratie. Een ruwe schets van onze Mona Lisa is uitgewerkt. We kunnen deze schets nu al aan onze klant of eindgebruikers laten zien. Sterker nog onze eindgebruikers zouden nu al mee aan het werk kunnen gaan met de website. Bijv. door de cliënten database te gaan vullen. Hoewel de website zelf nog maar erg weinig functionaliteit biedt. Maar, als eindgebruiker zou men nu al iets kunnen gaan zeggen over de layout of bijv. de gegevens die men mist bij een cliënt. En dat al na een klein uurtje werk. Moet je nagaan wat je na een dag werken in overleg met je eindgebruikers al bereikt zou kunnen hebben. Plus dat deze versie van de website de basis vormt voor de rest van onze ontwikkelingen. -Hieronder volgen, minder uitgebreidt nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op onze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. +Hieronder volgen, minder uitgebreidt, nog de nodige Django en Compass tips en notities over de uitbreidingen en wijzigingen op deze demo. De resultaten hiervan zijn in [Github](http://github.com/berry/Django-demo) terug te vinden. Bekijk vooral deze source code, lees het en leer ervan. Onderaan dit document vindt je ook een aantal referenties en links naar websites met meer informatie over Django, Compass, etc. ## CSS Debug grid In Blueprint kun je ook een debug grid aanzetten. Dit grid geeft je visuele aanwijzingen over de verdeling van de content over de kolommen van het grid. Wijzig de urls.py in de hoofddirectory van het project naar: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), ) We hebben een url pad toegevoegd voor images. We dienen de directory waarnaar verwezen wordt ook aan te maken. Vanuit de hoofddirectory van het project voer uit: mkdir static/images cp static/css/djangodemo/images/* ./static/images/ We hebben ook de plaatjes van de Compass directory naar de static/images gekopieerd. Nu kunnen we in de .sass bestanden +blueprint-debug en +showgrid toevoegen aan het bestand screen.sass: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") +blueprint-debug body // Uncomment next line to make the debug grid visible //+showgrid +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" Het +showgrid commando kun je nu aan en uitzetten. Zet je +showgrid aan dan wordt op de website een plaatje getoond met daarin de kolommen aangegeven. ## Referenties * De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. * De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. * Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. * Compass bouwt voort op [Sass](http://sass-lang.com/about.html). * Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). * Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. * Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file diff --git a/subjecten/templatetags/subjecten_extras.py b/subjecten/templatetags/subjecten_extras.py index 33c2894..f0155af 100644 --- a/subjecten/templatetags/subjecten_extras.py +++ b/subjecten/templatetags/subjecten_extras.py @@ -1,11 +1,26 @@ # template tags and filters import datetime from django import template register = template.Library() def leeftijd(value): - return (datetime.datetime.now().date() - value).days/365 + """ + Calculate the age of a user. + + value = datetime.date object for birth day + """ + today = datetime.date.today() + try: + birthday = datetime.date(today.year, value.month, value.day) + except ValueError: + # Raised when person was value on 29 February and the current + # year is not a leap year. + birthday = datetime.date(today.year, value.month, value.day - 1) + if birthday > today: + return today.year - value.year - 1 + else: + return today.year - value.year register.filter('leeftijd', leeftijd) \ No newline at end of file
berry/Django-demo
388ac90327e0fd12da24ea39976a7cf8ae29055a
Changed layout of subjecten detail.html page.
diff --git a/README.markdown b/README.markdown index 21a2170..785eacb 100644 --- a/README.markdown +++ b/README.markdown @@ -1,718 +1,715 @@  # Django & Compass gebruiken als een User Interaction Design tool * By: Berry Groenendijk * Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen realiseerde ik mij het volgende. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Het voordeel van een klikbare, functionele site is dat je daarmee gemakkelijker kan communiceren met eindgebruikers en bijvoorbeeld usability studies kan uitvoeren. Voor veel eindgebruikers is conceptueel denken heel lastig. En toch vragen we van gebruikers omdat te doen en vragen we zelfs wat er ontbreekt aan het concept en wat er beter aan kan. Het is niet gek dat we dan niet de juiste dingen te horen krijgen. Bouw snel, continu, release vaak en laat je gebruiker vaak naar het resultaat kijken. En wees niet bang om dingen weg te gooien en opnieuw te doen. Je gooit veel gemakkelijker iets weg waar je slechts weinig tijd aan hebt besteedt dan wanneer je er dagen of weken mee bezig bent geweest. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python 2.5](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. Ik heb Django-1.1.1 uitgepakt en de directory Django-1.1.1 in mijn eigen homedirectory "/Users/berry" geplaatst. * [Compass](http://wiki.github.com/chriseppstein/compass/getting-started). Voor Compass hebben we Ruby nodig. Op Mac OS X staat Ruby al. Vanaf de command prompt voer de volgende commando's uit: sudo gem update --system sudo gem install compass * Als database gebruiken we SQLite. En SQLite wordt meegeleverd met Python 2.5. Dus dat is ook al op de computer aanwezig. Dat is alles om aan de slag te kunnen. ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} + <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> - <th>Naam</th> - <th>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</th> - </tr> - <tr> - <td>Woonadres</td> - <td></td> + <th>Woonadres</th> + <th>Correspondentieadres</th> </tr> <tr> - <td>Straat</td> - <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} + <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> + {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> + {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> - </tr> - <tr> - <td>Postcode en woonplaats</td> - <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} + <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> + {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> + {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: compass -w We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. Screen.sass ziet er nu als volgt uit: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") body +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. [28 feb 2010: bug opgelost. De index.html pagina in de hoofddirectory van het project was opgeslagen als UTF-8 zonder BOM, terwijl alle andere pagina's in UTF-8 met BOM waren opgeslagen. Index.html ook in UTF-8 met BOM opgeslagen en toen zag de startpagina er wel goed uit.] Even terugkijken: we hebben nu een complete, functionele en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. Dit vormt onze eerste iteratie en de basis voor de rest van onze ontwikkelingen. ## CSS Debug grid In Blueprint kun je ook een debug grid aanzetten. Dit grid geeft je visuele aanwijzingen over de verdeling van de content over de kolommen van het grid. Wijzig de urls.py in de hoofddirectory van het project naar: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), ) We hebben een url pad toegevoegd voor images. We dienen de directory waarnaar verwezen wordt ook aan te maken. Vanuit de hoofddirectory van het project voer uit: mkdir static/images cp static/css/djangodemo/images/* ./static/images/ We hebben ook de plaatjes van de Compass directory naar de static/images gekopieerd. Nu kunnen we in de .sass bestanden +blueprint-debug en +showgrid toevoegen aan het bestand screen.sass: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") +blueprint-debug body // Uncomment next line to make the debug grid visible //+showgrid +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" Het +showgrid commando kun je nu aan en uitzetten. Zet je +showgrid aan dan wordt op de website een plaatje getoond met daarin de kolommen aangegeven. ## Referenties * De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. * De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. * Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. * Compass bouwt voort op [Sass](http://sass-lang.com/about.html). * Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). * Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. * Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file diff --git a/templates/subjecten/detail.html b/templates/subjecten/detail.html index c819554..5de9c1c 100644 --- a/templates/subjecten/detail.html +++ b/templates/subjecten/detail.html @@ -1,21 +1,21 @@ {% extends "base.html" %} {% block content %} <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> <th>Woonadres</th> - <th></th> + <th>Correspondentieadres</th> </tr> <tr> - <td>Straat</td> - <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} + <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> + {{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }}<br/> + {{ subject.woonadres_postcode|upper }}&nbsp;&nbsp;{{ subject.woonadres_woonplaats|upper }} </td> - </tr> - <tr> - <td>Postcode en woonplaats</td> - <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} + <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}<br/> + {{ subject.correspondentie_straatnaam }} {{ subject.correspondentie_huisnummer }} {{ subject.correspondentie_huisnummer_toevoeging }}<br/> + {{ subject.correspondentie_postcode|upper }}&nbsp;&nbsp;{{ subject.correspondentie_woonplaats|upper }} </td> </tr> </table> {% endblock content %} \ No newline at end of file
berry/Django-demo
d893fd697954850ecd579f251c77296334b4cc97
Completed README.
diff --git a/README.markdown b/README.markdown index dd0006d..21a2170 100644 --- a/README.markdown +++ b/README.markdown @@ -1,559 +1,563 @@  # Django & Compass gebruiken als een User Interaction Design tool * By: Berry Groenendijk * Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen realiseerde ik mij het volgende. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Het voordeel van een klikbare, functionele site is dat je daarmee gemakkelijker kan communiceren met eindgebruikers en bijvoorbeeld usability studies kan uitvoeren. Voor veel eindgebruikers is conceptueel denken heel lastig. En toch vragen we van gebruikers omdat te doen en vragen we zelfs wat er ontbreekt aan het concept en wat er beter aan kan. Het is niet gek dat we dan niet de juiste dingen te horen krijgen. Bouw snel, continu, release vaak en laat je gebruiker vaak naar het resultaat kijken. En wees niet bang om dingen weg te gooien en opnieuw te doen. Je gooit veel gemakkelijker iets weg waar je slechts weinig tijd aan hebt besteedt dan wanneer je er dagen of weken mee bezig bent geweest. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. -* [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. +* [Python 2.5](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. -* [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. +* [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. Ik heb Django-1.1.1 uitgepakt en de directory Django-1.1.1 in mijn eigen homedirectory "/Users/berry" geplaatst. * [Compass](http://wiki.github.com/chriseppstein/compass/getting-started). Voor Compass hebben we Ruby nodig. Op Mac OS X staat Ruby al. Vanaf de command prompt voer de volgende commando's uit: sudo gem update --system sudo gem install compass +* Als database gebruiken we SQLite. En SQLite wordt meegeleverd met Python 2.5. Dus dat is ook al op de computer aanwezig. + +Dat is alles om aan de slag te kunnen. + ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <table> <tr> <th>Naam</th> <th>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</th> </tr> <tr> <td>Woonadres</td> <td></td> </tr> <tr> <td>Straat</td> <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} </td> </tr> <tr> <td>Postcode en woonplaats</td> <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}),
berry/Django-demo
ff604edc5e325f29b800f167531a19ab1a2fc800
Fixed a bug in index.html. And added instructions how to enable Blueprint grid debugging.
diff --git a/README.markdown b/README.markdown index 66db96a..dd0006d 100644 --- a/README.markdown +++ b/README.markdown @@ -98,533 +98,617 @@ Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manie python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <h2>Lijst van cliënten</h2> <table> <tr> <th>Naam</th> <th>Woonplaats</th> </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <table> <tr> <th>Naam</th> <th>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</th> </tr> <tr> <td>Woonadres</td> <td></td> </tr> <tr> <td>Straat</td> <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} </td> </tr> <tr> <td>Postcode en woonplaats</td> <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: compass -w We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. Screen.sass ziet er nu als volgt uit: // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") body +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. -Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. +Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. [28 feb 2010: bug opgelost. De index.html pagina in de hoofddirectory van het project was opgeslagen als UTF-8 zonder BOM, terwijl alle andere pagina's in UTF-8 met BOM waren opgeslagen. Index.html ook in UTF-8 met BOM opgeslagen en toen zag de startpagina er wel goed uit.] Even terugkijken: we hebben nu een complete, functionele en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. Dit vormt onze eerste iteratie en de basis voor de rest van onze ontwikkelingen. +## CSS Debug grid + +In Blueprint kun je ook een debug grid aanzetten. Dit grid geeft je visuele aanwijzingen over de verdeling van de content over de kolommen van het grid. + +Wijzig de urls.py in de hoofddirectory van het project naar: + + from django.conf.urls.defaults import * + + # Uncomment the next two lines to enable the admin: + from django.contrib import admin + admin.autodiscover() + + urlpatterns = patterns("django.views.generic.simple", + + # Hoofdpagina's + (r'^$', "direct_to_template", {'template': 'index.html'}), + ) + + urlpatterns = urlpatterns + patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + # (r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), + + # Subjecten + (r'^subjecten/', include("djangodemo.subjecten.urls")), + + # Static media + # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. + (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), + (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), + ) + +We hebben een url pad toegevoegd voor images. We dienen de directory waarnaar verwezen wordt ook aan te maken. Vanuit de hoofddirectory van het project voer uit: + + mkdir static/images + cp static/css/djangodemo/images/* ./static/images/ + +We hebben ook de plaatjes van de Compass directory naar de static/images gekopieerd. + +Nu kunnen we in de .sass bestanden +blueprint-debug en +showgrid toevoegen aan het bestand screen.sass: + + // This import applies a global reset to any page that imports this stylesheet. + @import blueprint/reset.sass + // To configure blueprint, edit the partials/base.sass file. + @import partials/base.sass + // Import all the default blueprint modules so that we can access their mixins. + @import blueprint + // Import compass utilities + @import compass/utilities.sass + + // djangodemo layout + +blueprint-typography("body") + +blueprint-debug + body + // Uncomment next line to make the debug grid visible + //+showgrid + +container + !sidebar_columns = floor(!blueprint_grid_columns / 4) + #menu + +column(!sidebar_columns) + +no-bullets + #content + +column(!blueprint_grid_columns - !sidebar_columns, true) + #footer, #header + +column(!blueprint_grid_columns) + #footer + background-color = #eee + margin-top = 1em + +horizontal-list(5px) + + table + +table-scaffolding + th + background-color = #eee + text-align = "left" + +Het +showgrid commando kun je nu aan en uitzetten. Zet je +showgrid aan dan wordt op de website een plaatje getoond met daarin de kolommen aangegeven. + ## Referenties * De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. * De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. * Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. * Compass bouwt voort op [Sass](http://sass-lang.com/about.html). * Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). * Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. * Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file diff --git a/static/css/djangodemo/src/screen.sass b/static/css/djangodemo/src/screen.sass index d8802e6..ee08d76 100644 --- a/static/css/djangodemo/src/screen.sass +++ b/static/css/djangodemo/src/screen.sass @@ -1,31 +1,34 @@ // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint // Import compass utilities @import compass/utilities.sass // djangodemo layout +blueprint-typography("body") ++blueprint-debug body + // Uncomment next line to make the debug grid visible + //+showgrid +container !sidebar_columns = floor(!blueprint_grid_columns / 4) #menu +column(!sidebar_columns) +no-bullets #content +column(!blueprint_grid_columns - !sidebar_columns, true) #footer, #header +column(!blueprint_grid_columns) #footer background-color = #eee margin-top = 1em +horizontal-list(5px) table +table-scaffolding th background-color = #eee text-align = "left" \ No newline at end of file diff --git a/static/css/djangodemo/stylesheets/screen.css b/static/css/djangodemo/stylesheets/screen.css index 557db1e..ef1dac3 100644 --- a/static/css/djangodemo/stylesheets/screen.css +++ b/static/css/djangodemo/stylesheets/screen.css @@ -1,108 +1,110 @@ html, body { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, pre, a, abbr, acronym, address, code, del, dfn, em, img, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, caption, tbody, tfoot, thead, tr { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } blockquote, q { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; quotes: "" ""; } blockquote:before, q:before, blockquote:after, q:after { content: ""; } th, td, caption { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; text-align: left; font-weight: normal; vertical-align: middle; } table { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; border-collapse: separate; border-spacing: 0; vertical-align: middle; } a img { border: none; } body { line-height: 1.5; font-family: Helvetica Neue, Arial, Helvetica, sans-serif; color: #333333; font-size: 75%; } h1 { font-weight: normal; color: #222222; font-size: 3em; line-height: 1; margin-bottom: 0.5em; } h1 img { margin: 0; } h2 { font-weight: normal; color: #222222; font-size: 2em; margin-bottom: 0.75em; } h3 { font-weight: normal; color: #222222; font-size: 1.5em; line-height: 1; margin-bottom: 1em; } h4 { font-weight: normal; color: #222222; font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; } h5 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; margin-bottom: 1.5em; } h6 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; } h2 img, h3 img, h4 img, h5 img, h6 img { margin: 0; } p { margin: 0 0 1.5em; } p img.left { display: inline; float: left; margin: 1.5em 1.5em 1.5em 0; padding: 0; } p img.right { display: inline; float: right; margin: 1.5em 0 1.5em 1.5em; padding: 0; } a { text-decoration: underline; color: #000099; } a:visited { color: #000066; } a:focus { color: black; } a:hover { color: black; } a:active { color: #cc0099; } blockquote { margin: 1.5em; color: #666; font-style: italic; } strong { font-weight: bold; } em { font-style: italic; } dfn { font-style: italic; font-weight: bold; } sup, sub { line-height: 0; } abbr, acronym { border-bottom: 1px dotted #666; } address { margin: 0 0 1.5em; font-style: italic; } del { color: #666; } pre { margin: 1.5em 0; white-space: pre; } pre, code, tt { font: 1em 'andale mono', 'lucida console', monospace; line-height: 1.5; } li ul, li ol { margin: 0 1.5em; } ul { margin: 0 1.5em 1.5em 1.5em; list-style-type: disc; } ol { margin: 0 1.5em 1.5em 1.5em; list-style-type: decimal; } dl { margin: 0 0 1.5em 0; } dl dt { font-weight: bold; } dd { margin-left: 1.5em; } table { margin-bottom: 1.4em; width: 100%; } th { font-weight: bold; } thead th { background: #c3d9ff; } th, td, caption { padding: 4px 10px 4px 5px; } tr.even td { background: #e5ecf9; } tfoot { font-style: italic; } caption { background: #eee; } .quiet { color: #666666; } .loud { color: #111111; } +.showgrid { background: url('/images/grid.png?1267263512'); } + body { width: 950px; margin: 0 auto; overflow: hidden; display: inline-block; } body { display: block; } body #menu { display: inline; float: left; margin-right: 10px; width: 230px; } * html body #menu { overflow-x: hidden; } body #menu li { list-style-type: none; margin-left: 0px; } body #content { display: inline; float: left; margin-right: 0; width: 710px; } * html body #content { overflow-x: hidden; } body #footer, body #header { display: inline; float: left; margin-right: 10px; width: 950px; } * html body #footer, * html body #header { overflow-x: hidden; } body #footer { background-color: #eeeeee; margin-top: 1em; margin: 0; padding: 0; border: 0; outline: 0; overflow: hidden; display: inline-block; } body #footer { display: block; } body #footer li { list-style-type: none; margin-left: 0px; white-space: nowrap; display: inline; float: left; padding-left: 5px; padding-right: 5px; } body #footer li.first { padding-left: 0px; } body #footer li.last { padding-right: 0px; } table th { text-align: center; font-weight: bold; } table td, table th { padding: 2px; } table td.numeric, table th.numeric { text-align: right; } table th { background-color: #eeeeee; text-align: left; } diff --git a/static/images/grid.png b/static/images/grid.png new file mode 100644 index 0000000..129d4a2 Binary files /dev/null and b/static/images/grid.png differ diff --git a/templates/base.html b/templates/base.html index f289abb..c15701a 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,37 +1,36 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" - "http://www.w3.org/TR/html4/strict.dtd"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <title>Demo Django & Compass</title> - <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> - <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> + <title>Demo Django &amp; Compass</title> + <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css"> + <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css"> <!--[if lt IE 8]> - <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> + <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css"> <![endif]--> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head> <body> <div id="header"> - <h1>Demo Django & Compass</h1> + <h1>Demo Django &amp; Compass</h1> </div> <div id="menu"> <h2>Menu</h2> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy; 2010 - My Business</li> </ul> </div> </body> </html> \ No newline at end of file diff --git a/templates/index.html b/templates/index.html index 60045c1..996c738 100644 --- a/templates/index.html +++ b/templates/index.html @@ -1,7 +1,7 @@ -{% extends "base.html" %} +{% extends "base.html" %} {% block content %} <h2>Welkom</h2> - <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen + <p>Welkom bij deze demo van Django &amp; Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} \ No newline at end of file diff --git a/urls.py b/urls.py index df499ef..e0e121f 100644 --- a/urls.py +++ b/urls.py @@ -1,30 +1,31 @@ from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), + (r'^images/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static/images'}), )
berry/Django-demo
f043603e4d4d388c705ed7dd813bb7b4df938e8c
First iteration of Django demo is complete. The website is functional and styled. This is the basis for all future development efforts.
diff --git a/README.markdown b/README.markdown index 37cc3c9..66db96a 100644 --- a/README.markdown +++ b/README.markdown @@ -1,559 +1,630 @@ -# Django & Compass gebruiken als een User Interaction Design tool + +# Django & Compass gebruiken als een User Interaction Design tool * By: Berry Groenendijk * Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen realiseerde ik mij het volgende. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Het voordeel van een klikbare, functionele site is dat je daarmee gemakkelijker kan communiceren met eindgebruikers en bijvoorbeeld usability studies kan uitvoeren. Voor veel eindgebruikers is conceptueel denken heel lastig. En toch vragen we van gebruikers omdat te doen en vragen we zelfs wat er ontbreekt aan het concept en wat er beter aan kan. Het is niet gek dat we dan niet de juiste dingen te horen krijgen. Bouw snel, continu, release vaak en laat je gebruiker vaak naar het resultaat kijken. En wees niet bang om dingen weg te gooien en opnieuw te doen. Je gooit veel gemakkelijker iets weg waar je slechts weinig tijd aan hebt besteedt dan wanneer je er dagen of weken mee bezig bent geweest. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. * [Compass](http://wiki.github.com/chriseppstein/compass/getting-started). Voor Compass hebben we Ruby nodig. Op Mac OS X staat Ruby al. Vanaf de command prompt voer de volgende commando's uit: sudo gem update --system sudo gem install compass ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} + <h2>Lijst van cliënten</h2> <table> + <tr> + <th>Naam</th> + <th>Woonplaats</th> + </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: -{% block content %} - <table> - <tr> - <td>Naam</td> - <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> - </tr> - <tr> - <td>Woonadres</td> - <td></td> - </tr> - <tr> - <td>Straat</td> - <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} - </td> - </tr> - <tr> - <td>Postcode en woonplaats</td> - <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} - </td> - </tr> - </table> -{% endblock content %} + {% block content %} + <table> + <tr> + <th>Naam</th> + <th>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</th> + </tr> + <tr> + <td>Woonadres</td> + <td></td> + </tr> + <tr> + <td>Straat</td> + <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} + </td> + </tr> + <tr> + <td>Postcode en woonplaats</td> + <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} + </td> + </tr> + </table> + {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: mkdir static mkdir static/css cd static/css compass -f blueprint djangodemo We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), # Static media # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), ) Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. Nu gaan kunnen we de site gaan stijlen. -** waiting for more ** \ No newline at end of file + +Open een command prompt en ga naar de directory `/Users/berry/git/djangodemo/static/css/djangodemo`. Dit is de directory waar het Compass project is aangemaakt. We laten Compass deze directory bewaken, zodat iedere wijziging meteen wordt gecompileerd tot CSS bestanden: + + compass -w + +We gaan nu in de subdirectory stylesheets van het Compass project het bestand screen.sass aanpassen. Sass is een meta-taal waarmee je makkelijker, overzichtelijker en met meer kracht CSS kan schrijven. Vooral het gebruik van import, variabelen en mixins maakt Sass heel krachtig. Je kunt nu heel modulair te werk gaan in CSS. Compass zorgt er voor jou voor dat een en ander weer naar CSS wordt omgevormd. Deze techniek scheelt echt enorm veel tijd bij het maken en onderhouden van CSS. + +Screen.sass ziet er nu als volgt uit: + + // This import applies a global reset to any page that imports this stylesheet. + @import blueprint/reset.sass + // To configure blueprint, edit the partials/base.sass file. + @import partials/base.sass + // Import all the default blueprint modules so that we can access their mixins. + @import blueprint + // Import compass utilities + @import compass/utilities.sass + + // djangodemo layout + +blueprint-typography("body") + body + +container + !sidebar_columns = floor(!blueprint_grid_columns / 4) + #menu + +column(!sidebar_columns) + +no-bullets + #content + +column(!blueprint_grid_columns - !sidebar_columns, true) + #footer, #header + +column(!blueprint_grid_columns) + #footer + background-color = #eee + margin-top = 1em + +horizontal-list(5px) + + table + +table-scaffolding + th + background-color = #eee + text-align = "left" + +De website ziet er nu eenvoudig met wel gestyled uit. We maken hier gebruik van het Blueprint CSS framework. Dit framework biedt een mooi grid waarmee je een webpagina strak kan indelen in functionele kolommen en blokken. + +Compass biedt ook een aantal handige mixins waarmee je bijv. een unordered-list gemakkelijk horizontaal kan weergeven. Zoals we in de footer hebben gedaan. + +Bug: op mijn laptop staat de titel op de homepage helemaal bovenaan, terwijl die op alle andere pagina's netjes ruimte heeft bovenaan. Geen idee waarom dat dit is. Ik ben dan ook geen HTML-CSS expert. + +Even terugkijken: we hebben nu een complete, functionele en klikbare website die ook nog eens (eenvoudig) gestyled is. Plus dat we een admin interface hebben waarmee we onze tabellen kunnen vullen en onderhouden. + +Dit vormt onze eerste iteratie en de basis voor de rest van onze ontwikkelingen. + +## Referenties + +* De [Django tutorial](http://docs.djangoproject.com/en/dev/intro/tutorial01/) is een zeer goede introductie in het gebruik van Django. Deze demo volgt grotendeels ook deze introductie. De introductie legt op onderdelen echter iets meer uit. Ik heb slechts een introductie op de introductie gegeven. + +* De grote kracht van Django is de [documentatie](http://docs.djangoproject.com/en/1.1/). Algemeen wordt erkend dat deze documentatie zeer goed geschreven is en mede de basis vormt voor het succes van Django. Je vindt heel gemakkelijk dingen terug en je leert dan ook heel snel meer van Django. + +* Voor het gebruik van [Compass](http://wiki.github.com/chriseppstein/compass/) is een screencast gemaakt. Deze is informatief maar duurt wel wat lang (50 minuten). Het laat wel zien hoe krachtig Compass is. + +* Compass bouwt voort op [Sass](http://sass-lang.com/about.html). + +* Deze [Django demo](http://github.com/berry/Django-demo) heb ik op Github geplaatst. Github is gratis voor open source projecten en biedt een geweldige webinterface op [Git](http://git-scm.com/). + +* Django is geschreven in [Python](http://python.org/). Python is een krachtige dynamische programmeertaal. Ontstaan bij het [CWI](http://www.cwi.nl/) in Amsterdam en geschreven door [Guido van Rossum](http://www.python.org/~guido/). Python kent een (zeer) grote schare aanhangers en wordt door zeer vele organisaties gebruikt. Python leren is gemakkelijk. In zeer korte tijd ben je als programmeur als heel effectief bezig met het maken van functionele programma's. Python kent, zeker in tegenstelling tot Java, maar weinig boeken. Dat is geen indicatie dat Python weinig gebruikt wordt, maar een indicatie van de eenvoud van de taal. + +* Compass en Sass zijn geschreven in [Ruby](http://www.ruby-lang.org/en/). Ruby heeft dynamische programmeertalen enorm populair gemaakt. Python en Ruby worden heel vaak als elkaars concurrenten gezien. Maar, er is ruimte genoeg voor beide talen. \ No newline at end of file diff --git a/static/css/djangodemo/src/screen.sass b/static/css/djangodemo/src/screen.sass index e3588dc..d8802e6 100644 --- a/static/css/djangodemo/src/screen.sass +++ b/static/css/djangodemo/src/screen.sass @@ -1,40 +1,31 @@ // This import applies a global reset to any page that imports this stylesheet. @import blueprint/reset.sass // To configure blueprint, edit the partials/base.sass file. @import partials/base.sass // Import all the default blueprint modules so that we can access their mixins. @import blueprint -// Import the non-default scaffolding module. -@import blueprint/modules/scaffolding.sass +// Import compass utilities +@import compass/utilities.sass -// To generate css equivalent to the blueprint css but with your configuration applied, uncomment: -// +blueprint - -//Recommended Blueprint configuration with scoping and semantic layout: -+blueprint-typography("body.bp") -+blueprint-scaffolding("body.bp") -body.bp - +blueprint-utilities - +blueprint-debug - +blueprint-interaction - // Remove the scaffolding when you're ready to start doing visual design. - // Or leave it in if you're happy with how blueprint looks out-of-the-box -form.bp - +blueprint-form - -// Page layout can be done using mixins applied to your semantic classes and IDs: -body.three-col - #container - +container - #header, #footer - +column(!blueprint_grid_columns) - #sidebar - // One third of the grid columns, rounding down. With 24 cols, this is 8. - !sidebar_columns = floor(!blueprint_grid_columns / 3) +// djangodemo layout ++blueprint-typography("body") +body + +container + !sidebar_columns = floor(!blueprint_grid_columns / 4) + #menu +column(!sidebar_columns) + +no-bullets #content - // Two thirds of the grid columns, rounding up. - // With 24 cols, this is 16. - !content_columns = ceil(2 * !blueprint_grid_columns / 3) - // true means it's the last column in the row - +column(!content_columns, true) + +column(!blueprint_grid_columns - !sidebar_columns, true) + #footer, #header + +column(!blueprint_grid_columns) + #footer + background-color = #eee + margin-top = 1em + +horizontal-list(5px) + +table + +table-scaffolding + th + background-color = #eee + text-align = "left" \ No newline at end of file diff --git a/static/css/djangodemo/stylesheets/screen.css b/static/css/djangodemo/stylesheets/screen.css index d3eda90..557db1e 100644 --- a/static/css/djangodemo/stylesheets/screen.css +++ b/static/css/djangodemo/stylesheets/screen.css @@ -1,106 +1,108 @@ html, body { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, pre, a, abbr, acronym, address, code, del, dfn, em, img, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, caption, tbody, tfoot, thead, tr { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } blockquote, q { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; quotes: "" ""; } blockquote:before, q:before, blockquote:after, q:after { content: ""; } th, td, caption { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; text-align: left; font-weight: normal; vertical-align: middle; } table { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; border-collapse: separate; border-spacing: 0; vertical-align: middle; } a img { border: none; } -body.bp { line-height: 1.5; font-family: Helvetica Neue, Arial, Helvetica, sans-serif; color: #333333; font-size: 75%; } -body.bp h1 { font-weight: normal; color: #222222; font-size: 3em; line-height: 1; margin-bottom: 0.5em; } -body.bp h1 img { margin: 0; } -body.bp h2 { font-weight: normal; color: #222222; font-size: 2em; margin-bottom: 0.75em; } -body.bp h3 { font-weight: normal; color: #222222; font-size: 1.5em; line-height: 1; margin-bottom: 1em; } -body.bp h4 { font-weight: normal; color: #222222; font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; } -body.bp h5 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; margin-bottom: 1.5em; } -body.bp h6 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; } -body.bp h2 img, body.bp h3 img, body.bp h4 img, body.bp h5 img, body.bp h6 img { margin: 0; } -body.bp p { margin: 0 0 1.5em; } -body.bp p img.left { display: inline; float: left; margin: 1.5em 1.5em 1.5em 0; padding: 0; } -body.bp p img.right { display: inline; float: right; margin: 1.5em 0 1.5em 1.5em; padding: 0; } -body.bp a { text-decoration: underline; color: #000099; } -body.bp a:visited { color: #000066; } -body.bp a:focus { color: black; } -body.bp a:hover { color: black; } -body.bp a:active { color: #cc0099; } -body.bp blockquote { margin: 1.5em; color: #666; font-style: italic; } -body.bp strong { font-weight: bold; } -body.bp em { font-style: italic; } -body.bp dfn { font-style: italic; font-weight: bold; } -body.bp sup, body.bp sub { line-height: 0; } -body.bp abbr, body.bp acronym { border-bottom: 1px dotted #666; } -body.bp address { margin: 0 0 1.5em; font-style: italic; } -body.bp del { color: #666; } -body.bp pre { margin: 1.5em 0; white-space: pre; } -body.bp pre, body.bp code, body.bp tt { font: 1em 'andale mono', 'lucida console', monospace; line-height: 1.5; } -body.bp li ul, body.bp li ol { margin: 0 1.5em; } -body.bp ul { margin: 0 1.5em 1.5em 1.5em; list-style-type: disc; } -body.bp ol { margin: 0 1.5em 1.5em 1.5em; list-style-type: decimal; } -body.bp dl { margin: 0 0 1.5em 0; } -body.bp dl dt { font-weight: bold; } -body.bp dd { margin-left: 1.5em; } -body.bp table { margin-bottom: 1.4em; width: 100%; } -body.bp th { font-weight: bold; } -body.bp thead th { background: #c3d9ff; } -body.bp th, body.bp td, body.bp caption { padding: 4px 10px 4px 5px; } -body.bp tr.even td { background: #e5ecf9; } -body.bp tfoot { font-style: italic; } -body.bp caption { background: #eee; } -body.bp .quiet { color: #666666; } -body.bp .loud { color: #111111; } - -body.bp .box { padding: 1.5em; margin-bottom: 1.5em; background: #E5ECF9; } -body.bp div.border { padding-right: 4px; margin-right: 5px; border-right: 1px solid #eeeeee; } -body.bp div.colborder { padding-right: 24px; margin-right: 25px; border-right: 1px solid #eeeeee; } -body.bp hr { background: #dddddd; color: #dddddd; clear: both; float: none; width: 100%; height: .1em; margin: 0 0 1.45em; border: none; } -body.bp hr.space { background: #dddddd; color: #dddddd; clear: both; float: none; width: 100%; height: .1em; margin: 0 0 1.45em; border: none; background: #fff; color: #fff; } - -body.bp .clear { clear: both; } -body.bp .nowrap { white-space: nowrap; } -body.bp .clearfix { overflow: hidden; display: inline-block; } -body.bp .clearfix { display: block; } -body.bp .small { font-size: .8em; margin-bottom: 1.875em; line-height: 1.875em; } -body.bp .large { font-size: 1.2em; line-height: 2.5em; margin-bottom: 1.25em; } -body.bp .first { margin-left: 0; padding-left: 0; } -body.bp .last { margin-right: 0; padding-right: 0; } -body.bp .top { margin-top: 0; padding-top: 0; } -body.bp .bottom { margin-bottom: 0; padding-bottom: 0; } -body.bp .showgrid { background: url('/images/grid.png?1267263512'); } -body.bp .error { padding: .8em; margin-bottom: 1em; border: 2px solid #dddddd; background: #fbe3e4; color: #8a1f11; border-color: #fbc2c4; } -body.bp .error a { color: #8a1f11; } -body.bp .notice { padding: .8em; margin-bottom: 1em; border: 2px solid #dddddd; background: #fff6bf; color: #514721; border-color: #ffd324; } -body.bp .notice a { color: #514721; } -body.bp .success { padding: .8em; margin-bottom: 1em; border: 2px solid #dddddd; background: #e6efc2; color: #264409; border-color: #c6d880; } -body.bp .success a { color: #264409; } -body.bp .hide { display: none; } -body.bp .highlight { background: yellow; } -body.bp .added { background: #006600; color: white; } -body.bp .removed { background: #990000; color: white; } - -form.bp label { font-weight: bold; } -form.bp fieldset { padding: 1.4em; margin: 0 0 1.5em 0; } -form.bp legend { font-weight: bold; font-size: 1.2em; } -form.bp input.text, form.bp input.title, form.bp input[type=text] { margin: 0.5em 0; background-color: #fff; padding: 5px; } -form.bp input.title { font-size: 1.5em; } -form.bp input[type=checkbox], form.bp input.checkbox, form.bp input[type=radio], form.bp input.radio { position: relative; top: 0.25em; } -form.bp textarea { margin: 0.5em 0; padding: 5px; } -form.bp select { margin: 0.5em 0; } -form.bp fieldset { border: 1px solid #cccccc; } -form.bp input.text, form.bp input.title, form.bp textarea, form.bp select { border: 1px solid #bbbbbb; } -form.bp input.text:focus, form.bp input.title:focus, form.bp textarea:focus, form.bp select:focus { border: 1px solid #666666; } -form.bp input.text, form.bp input.title { width: 300px; } -form.bp textarea { width: 390px; height: 250px; } - -body.three-col #container { width: 950px; margin: 0 auto; overflow: hidden; display: inline-block; } -body.three-col #container { display: block; } -body.three-col #header, body.three-col #footer { display: inline; float: left; margin-right: 10px; width: 950px; } -* html body.three-col #header, * html body.three-col #footer { overflow-x: hidden; } -body.three-col #sidebar { display: inline; float: left; margin-right: 10px; width: 310px; } -* html body.three-col #sidebar { overflow-x: hidden; } -body.three-col #content { display: inline; float: left; margin-right: 0; width: 630px; } -* html body.three-col #content { overflow-x: hidden; } +body { line-height: 1.5; font-family: Helvetica Neue, Arial, Helvetica, sans-serif; color: #333333; font-size: 75%; } + +h1 { font-weight: normal; color: #222222; font-size: 3em; line-height: 1; margin-bottom: 0.5em; } +h1 img { margin: 0; } + +h2 { font-weight: normal; color: #222222; font-size: 2em; margin-bottom: 0.75em; } + +h3 { font-weight: normal; color: #222222; font-size: 1.5em; line-height: 1; margin-bottom: 1em; } + +h4 { font-weight: normal; color: #222222; font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; } + +h5 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; margin-bottom: 1.5em; } + +h6 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; } + +h2 img, h3 img, h4 img, h5 img, h6 img { margin: 0; } + +p { margin: 0 0 1.5em; } +p img.left { display: inline; float: left; margin: 1.5em 1.5em 1.5em 0; padding: 0; } +p img.right { display: inline; float: right; margin: 1.5em 0 1.5em 1.5em; padding: 0; } + +a { text-decoration: underline; color: #000099; } +a:visited { color: #000066; } +a:focus { color: black; } +a:hover { color: black; } +a:active { color: #cc0099; } + +blockquote { margin: 1.5em; color: #666; font-style: italic; } + +strong { font-weight: bold; } + +em { font-style: italic; } + +dfn { font-style: italic; font-weight: bold; } + +sup, sub { line-height: 0; } + +abbr, acronym { border-bottom: 1px dotted #666; } + +address { margin: 0 0 1.5em; font-style: italic; } + +del { color: #666; } + +pre { margin: 1.5em 0; white-space: pre; } + +pre, code, tt { font: 1em 'andale mono', 'lucida console', monospace; line-height: 1.5; } + +li ul, li ol { margin: 0 1.5em; } + +ul { margin: 0 1.5em 1.5em 1.5em; list-style-type: disc; } + +ol { margin: 0 1.5em 1.5em 1.5em; list-style-type: decimal; } + +dl { margin: 0 0 1.5em 0; } +dl dt { font-weight: bold; } + +dd { margin-left: 1.5em; } + +table { margin-bottom: 1.4em; width: 100%; } + +th { font-weight: bold; } + +thead th { background: #c3d9ff; } + +th, td, caption { padding: 4px 10px 4px 5px; } + +tr.even td { background: #e5ecf9; } + +tfoot { font-style: italic; } + +caption { background: #eee; } + +.quiet { color: #666666; } + +.loud { color: #111111; } + +body { width: 950px; margin: 0 auto; overflow: hidden; display: inline-block; } +body { display: block; } +body #menu { display: inline; float: left; margin-right: 10px; width: 230px; } +* html body #menu { overflow-x: hidden; } +body #menu li { list-style-type: none; margin-left: 0px; } +body #content { display: inline; float: left; margin-right: 0; width: 710px; } +* html body #content { overflow-x: hidden; } +body #footer, body #header { display: inline; float: left; margin-right: 10px; width: 950px; } +* html body #footer, * html body #header { overflow-x: hidden; } +body #footer { background-color: #eeeeee; margin-top: 1em; margin: 0; padding: 0; border: 0; outline: 0; overflow: hidden; display: inline-block; } +body #footer { display: block; } +body #footer li { list-style-type: none; margin-left: 0px; white-space: nowrap; display: inline; float: left; padding-left: 5px; padding-right: 5px; } +body #footer li.first { padding-left: 0px; } +body #footer li.last { padding-right: 0px; } + +table th { text-align: center; font-weight: bold; } +table td, table th { padding: 2px; } +table td.numeric, table th.numeric { text-align: right; } +table th { background-color: #eeeeee; text-align: left; } diff --git a/templates/base.html b/templates/base.html index 49833b1..f289abb 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,36 +1,37 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> <!--[if lt IE 8]> <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> <![endif]--> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> + <h2>Menu</h2> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> - <li>&copy;</li> + <li>&copy; 2010 - My Business</li> </ul> </div> </body> </html> \ No newline at end of file diff --git a/templates/index.html b/templates/index.html index d8a3ac1..60045c1 100644 --- a/templates/index.html +++ b/templates/index.html @@ -1,6 +1,7 @@ {% extends "base.html" %} {% block content %} + <h2>Welkom</h2> <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/detail.html b/templates/subjecten/detail.html index 7eba656..c819554 100644 --- a/templates/subjecten/detail.html +++ b/templates/subjecten/detail.html @@ -1,24 +1,21 @@ -{% extends "base.html" %} +{% extends "base.html" %} {% block content %} + <h2>Cliëntgegevens van {{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</h2> <table> <tr> - <td>Naam</td> - <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> - </tr> - <tr> - <td>Woonadres</td> - <td></td> + <th>Woonadres</th> + <th></th> </tr> <tr> <td>Straat</td> <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} </td> </tr> <tr> <td>Postcode en woonplaats</td> <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} </td> </tr> </table> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html index 4245d0d..ff6e77b 100644 --- a/templates/subjecten/index.html +++ b/templates/subjecten/index.html @@ -1,12 +1,17 @@ -{% extends "base.html" %} +{% extends "base.html" %} {% block content %} + <h2>Lijst van cliënten</h2> <table> + <tr> + <th>Naam</th> + <th>Woonplaats</th> + </tr> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} \ No newline at end of file
berry/Django-demo
7a2bdae5786a56e8f8b3d2cc667ca73f912e0d90
Created static media directory. Created Compass project. Added links to CSS in HTML header. We are ready to style our website.
diff --git a/README.markdown b/README.markdown index 953a7ff..37cc3c9 100644 --- a/README.markdown +++ b/README.markdown @@ -1,498 +1,559 @@ # Django & Compass gebruiken als een User Interaction Design tool -By: Berry Groenendijk - -Date: 25 february 2010 +* By: Berry Groenendijk +* Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel -Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). +Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen realiseerde ik mij het volgende. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. +Het voordeel van een klikbare, functionele site is dat je daarmee gemakkelijker kan communiceren met eindgebruikers en bijvoorbeeld usability studies kan uitvoeren. + +Voor veel eindgebruikers is conceptueel denken heel lastig. En toch vragen we van gebruikers omdat te doen en vragen we zelfs wat er ontbreekt aan het concept en wat er beter aan kan. Het is niet gek dat we dan niet de juiste dingen te horen krijgen. + +Bouw snel, continu, release vaak en laat je gebruiker vaak naar het resultaat kijken. En wees niet bang om dingen weg te gooien en opnieuw te doen. Je gooit veel gemakkelijker iets weg waar je slechts weinig tijd aan hebt besteedt dan wanneer je er dagen of weken mee bezig bent geweest. + Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. -* **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie +* [Compass](http://wiki.github.com/chriseppstein/compass/getting-started). Voor Compass hebben we Ruby nodig. Op Mac OS X staat Ruby al. Vanaf de command prompt voer de volgende commando's uit: + + sudo gem update --system + sudo gem install compass ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <table> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <table> <tr> <td>Naam</td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> </tr> <tr> <td>Woonadres</td> <td></td> </tr> <tr> <td>Straat</td> <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} </td> </tr> <tr> <td>Postcode en woonplaats</td> <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> Wees er zeker van dat je het bestand als UTF-8 opslaat. We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: {% extends "base.html" %} Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: {% extends "base.html" %} {% block content %} <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> {% endblock content %} Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. ## De site vormgeven met behulp van Compass +Voer de volgende commando's vanuit de hoofddirectory van het djangodemo project: + + mkdir static + mkdir static/css + cd static/css + compass -f blueprint djangodemo + +We maken gebruik van het blueprint CSS framework. Compass maakt nu een hele serie directories en bestanden aan. Ook geeft Compass nu aanwijzingen om de CSS in je HTML te linken. Neem deze aanwijzingen over in het base.html bestand, de head van base.html ziet er nu als volgt uit: + + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>Demo Django & Compass</title> + <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> + <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> + <!--[if lt IE 8]> + <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> + <![endif]--> + </head> + +Als we kijken of de CSS wordt opgepikt dan blijkt dat niet zo te zijn. De url naar de static directory wordt nog niet opgepikt. Dat moeten we even rechttrekken. Open urls.py en wijzig deze in: + + from django.conf.urls.defaults import * + + # Uncomment the next two lines to enable the admin: + from django.contrib import admin + admin.autodiscover() + + urlpatterns = patterns("django.views.generic.simple", + + # Hoofdpagina's + (r'^$', "direct_to_template", {'template': 'index.html'}), + ) + + urlpatterns = urlpatterns + patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + # (r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), + + # Subjecten + (r'^subjecten/', include("djangodemo.subjecten.urls")), + + # Static media + # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. + (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), + ) +Onder aan het bestand heb we een regel toegevoegd waarmee de statische media in de directory `/Users/berry/git/djangodemo/static` worden geserveerd door de development server. Als je nu een pagina bekijkt dan zie je dat de CSS netjs wordt opgepikt. De layout is iets gewijzigd t.o.v. van eerst. +Nu gaan kunnen we de site gaan stijlen. ** waiting for more ** \ No newline at end of file diff --git a/static/css/djangodemo/config.rb b/static/css/djangodemo/config.rb new file mode 100644 index 0000000..03ebceb --- /dev/null +++ b/static/css/djangodemo/config.rb @@ -0,0 +1,10 @@ +# Require any additional compass plugins here. +project_type = :stand_alone +# Set this to the root of your project when deployed: +http_path = "/" +css_dir = "stylesheets" +sass_dir = "src" +images_dir = "images" +output_style = :compact +# To enable relative paths to assets via compass helper functions. Uncomment: +# relative_assets = true diff --git a/static/css/djangodemo/images/grid.png b/static/css/djangodemo/images/grid.png new file mode 100644 index 0000000..129d4a2 Binary files /dev/null and b/static/css/djangodemo/images/grid.png differ diff --git a/static/css/djangodemo/src/.sass-cache/0617d096342054bee450524a54366a567eeb4981/_blueprint.sassc b/static/css/djangodemo/src/.sass-cache/0617d096342054bee450524a54366a567eeb4981/_blueprint.sassc new file mode 100644 index 0000000..37383da Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/0617d096342054bee450524a54366a567eeb4981/_blueprint.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_ie.sassc b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_ie.sassc new file mode 100644 index 0000000..3053d4d Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_ie.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_print.sassc b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_print.sassc new file mode 100644 index 0000000..32e78c4 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_print.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_reset.sassc b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_reset.sassc new file mode 100644 index 0000000..9f2243d Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_reset.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_screen.sassc b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_screen.sassc new file mode 100644 index 0000000..854a649 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/45172cfe9c00b8ca879648bfff0e96f3231bb00e/_screen.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/46536ecba9ec416c9db3ed3c6caf09984e0dbe3e/_link_colors.sassc b/static/css/djangodemo/src/.sass-cache/46536ecba9ec416c9db3ed3c6caf09984e0dbe3e/_link_colors.sassc new file mode 100644 index 0000000..e047ee9 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/46536ecba9ec416c9db3ed3c6caf09984e0dbe3e/_link_colors.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_colors.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_colors.sassc new file mode 100644 index 0000000..ed05938 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_colors.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_debug.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_debug.sassc new file mode 100644 index 0000000..39ba1a9 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_debug.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_form.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_form.sassc new file mode 100644 index 0000000..65b5006 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_form.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_grid.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_grid.sassc new file mode 100644 index 0000000..67940c9 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_grid.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_interaction.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_interaction.sassc new file mode 100644 index 0000000..ba66288 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_interaction.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_reset.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_reset.sassc new file mode 100644 index 0000000..3d72c47 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_reset.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_scaffolding.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_scaffolding.sassc new file mode 100644 index 0000000..cb6d2b0 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_scaffolding.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_typography.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_typography.sassc new file mode 100644 index 0000000..e2bb38a Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_typography.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_utilities.sassc b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_utilities.sassc new file mode 100644 index 0000000..103785b Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/5debb2fb706b5991e0c99659ae44d3713779cf9f/_utilities.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_clearfix.sassc b/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_clearfix.sassc new file mode 100644 index 0000000..53049d1 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_clearfix.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_float.sassc b/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_float.sassc new file mode 100644 index 0000000..1e45dca Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_float.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_hacks.sassc b/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_hacks.sassc new file mode 100644 index 0000000..c7df25e Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/669177b24888cd2f55d8b961caf59756e4150aa7/_hacks.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/c2b9a94b105c2d922f10020f84589dbba0492d83/_nowrap.sassc b/static/css/djangodemo/src/.sass-cache/c2b9a94b105c2d922f10020f84589dbba0492d83/_nowrap.sassc new file mode 100644 index 0000000..102a96c Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/c2b9a94b105c2d922f10020f84589dbba0492d83/_nowrap.sassc differ diff --git a/static/css/djangodemo/src/.sass-cache/f53a18b3d3affdc3b5426c960a93a46deeb692e4/_base.sassc b/static/css/djangodemo/src/.sass-cache/f53a18b3d3affdc3b5426c960a93a46deeb692e4/_base.sassc new file mode 100644 index 0000000..b343042 Binary files /dev/null and b/static/css/djangodemo/src/.sass-cache/f53a18b3d3affdc3b5426c960a93a46deeb692e4/_base.sassc differ diff --git a/static/css/djangodemo/src/ie.sass b/static/css/djangodemo/src/ie.sass new file mode 100644 index 0000000..fad0915 --- /dev/null +++ b/static/css/djangodemo/src/ie.sass @@ -0,0 +1,15 @@ +@import blueprint.sass + ++blueprint-ie + +// Note : +// +// Compass will center text to fix IE6 container centering. +// This means all your texts will be centered under all version of IE by default. +// Please don't forget to restore the correct behavior to your main container (but not the body tag!) +// +// Example : +// +// .container, .footer +// :text-align left + diff --git a/static/css/djangodemo/src/partials/_base.sass b/static/css/djangodemo/src/partials/_base.sass new file mode 100644 index 0000000..f6d45e5 --- /dev/null +++ b/static/css/djangodemo/src/partials/_base.sass @@ -0,0 +1,11 @@ +// Here is where you can define your constants for your application and to configure the blueprint framework. +// Feel free to delete these if you want keep the defaults: + +!blueprint_grid_columns = 24 +!blueprint_container_size = 950px +!blueprint_grid_margin = 10px + +// Use this to calculate the width based on the total width. +// Or you can set !blueprint_grid_width to a fixed value and unset !blueprint_container_size -- it will be calculated for you. +!blueprint_grid_width = (!blueprint_container_size + !blueprint_grid_margin) / !blueprint_grid_columns - !blueprint_grid_margin + diff --git a/static/css/djangodemo/src/print.sass b/static/css/djangodemo/src/print.sass new file mode 100644 index 0000000..8e5d49d --- /dev/null +++ b/static/css/djangodemo/src/print.sass @@ -0,0 +1,3 @@ +@import blueprint.sass + ++blueprint-print \ No newline at end of file diff --git a/static/css/djangodemo/src/screen.sass b/static/css/djangodemo/src/screen.sass new file mode 100644 index 0000000..e3588dc --- /dev/null +++ b/static/css/djangodemo/src/screen.sass @@ -0,0 +1,40 @@ +// This import applies a global reset to any page that imports this stylesheet. +@import blueprint/reset.sass +// To configure blueprint, edit the partials/base.sass file. +@import partials/base.sass +// Import all the default blueprint modules so that we can access their mixins. +@import blueprint +// Import the non-default scaffolding module. +@import blueprint/modules/scaffolding.sass + +// To generate css equivalent to the blueprint css but with your configuration applied, uncomment: +// +blueprint + +//Recommended Blueprint configuration with scoping and semantic layout: ++blueprint-typography("body.bp") ++blueprint-scaffolding("body.bp") +body.bp + +blueprint-utilities + +blueprint-debug + +blueprint-interaction + // Remove the scaffolding when you're ready to start doing visual design. + // Or leave it in if you're happy with how blueprint looks out-of-the-box +form.bp + +blueprint-form + +// Page layout can be done using mixins applied to your semantic classes and IDs: +body.three-col + #container + +container + #header, #footer + +column(!blueprint_grid_columns) + #sidebar + // One third of the grid columns, rounding down. With 24 cols, this is 8. + !sidebar_columns = floor(!blueprint_grid_columns / 3) + +column(!sidebar_columns) + #content + // Two thirds of the grid columns, rounding up. + // With 24 cols, this is 16. + !content_columns = ceil(2 * !blueprint_grid_columns / 3) + // true means it's the last column in the row + +column(!content_columns, true) diff --git a/static/css/djangodemo/stylesheets/ie.css b/static/css/djangodemo/stylesheets/ie.css new file mode 100644 index 0000000..f1b3097 --- /dev/null +++ b/static/css/djangodemo/stylesheets/ie.css @@ -0,0 +1,31 @@ +body { text-align: center; } +* html body legend { margin: 0px -8px 16px 0; padding: 0; } +html>body p code { *white-space: normal; } + +.container { text-align: left; } + +ol { margin-left: 2em; } + +sup { vertical-align: text-top; } + +sub { vertical-align: text-bottom; } + +hr { margin: -8px auto 11px; } + +img { -ms-interpolation-mode: bicubic; } + +fieldset { padding-top: 0; } + +input.text { margin: 0.5em 0; background-color: #fff; border: 1px solid #bbb; } +input.text:focus { border: 1px solid #666; } +input.title { margin: 0.5em 0; background-color: #fff; border: 1px solid #bbb; } +input.title:focus { border: 1px solid #666; } +input.checkbox { position: relative; top: 0.25em; } +input.radio { position: relative; top: 0.25em; } +input.button { position: relative; top: 0.25em; } + +textarea { margin: 0.5em 0; } + +select { margin: 0.5em 0; } + +button { position: relative; top: 0.25em; } diff --git a/static/css/djangodemo/stylesheets/print.css b/static/css/djangodemo/stylesheets/print.css new file mode 100644 index 0000000..2a70a98 --- /dev/null +++ b/static/css/djangodemo/stylesheets/print.css @@ -0,0 +1,27 @@ +body { line-height: 1.5; font-family: Helvetica Neue, Arial, Helvetica, sans-serif; color: #000; background: none; font-size: 10pt; } + +.container { background: none; } + +hr { background: #ccc; color: #ccc; width: 100%; height: 2px; margin: 2em 0; padding: 0; border: none; } +hr.space { background: #fff; color: #fff; } + +h1, h2, h3, h4, h5, h6 { font-family: Helvetica Neue, Arial, Helvetica, sans-serif; } + +code { font-size: .9em; font-family: 'andale mono', 'lucida console', monospace; } + +img { display: inline; float: left; margin: 1.5em 1.5em 1.5em 0; } + +a img { border: none; } +a:link, a:visited { background: transparent; font-weight: 700; text-decoration: underline; } + +p img.top { margin-top: 0; } + +blockquote { margin: 1.5em; padding: 1em; font-style: italic; font-size: .9em; } + +.small { font-size: .9em; } + +.large { font-size: 1.1em; } + +.quiet { color: #999; } + +.hide { display: none; } diff --git a/static/css/djangodemo/stylesheets/screen.css b/static/css/djangodemo/stylesheets/screen.css new file mode 100644 index 0000000..d3eda90 --- /dev/null +++ b/static/css/djangodemo/stylesheets/screen.css @@ -0,0 +1,106 @@ +html, body { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } + +div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, pre, a, abbr, acronym, address, code, del, dfn, em, img, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, caption, tbody, tfoot, thead, tr { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; } + +blockquote, q { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; quotes: "" ""; } +blockquote:before, q:before, blockquote:after, q:after { content: ""; } + +th, td, caption { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; text-align: left; font-weight: normal; vertical-align: middle; } + +table { margin: 0; padding: 0; border: 0; font-weight: inherit; font-style: inherit; font-size: 100%; font-family: inherit; vertical-align: baseline; border-collapse: separate; border-spacing: 0; vertical-align: middle; } + +a img { border: none; } + +body.bp { line-height: 1.5; font-family: Helvetica Neue, Arial, Helvetica, sans-serif; color: #333333; font-size: 75%; } +body.bp h1 { font-weight: normal; color: #222222; font-size: 3em; line-height: 1; margin-bottom: 0.5em; } +body.bp h1 img { margin: 0; } +body.bp h2 { font-weight: normal; color: #222222; font-size: 2em; margin-bottom: 0.75em; } +body.bp h3 { font-weight: normal; color: #222222; font-size: 1.5em; line-height: 1; margin-bottom: 1em; } +body.bp h4 { font-weight: normal; color: #222222; font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; } +body.bp h5 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; margin-bottom: 1.5em; } +body.bp h6 { font-weight: normal; color: #222222; font-size: 1em; font-weight: bold; } +body.bp h2 img, body.bp h3 img, body.bp h4 img, body.bp h5 img, body.bp h6 img { margin: 0; } +body.bp p { margin: 0 0 1.5em; } +body.bp p img.left { display: inline; float: left; margin: 1.5em 1.5em 1.5em 0; padding: 0; } +body.bp p img.right { display: inline; float: right; margin: 1.5em 0 1.5em 1.5em; padding: 0; } +body.bp a { text-decoration: underline; color: #000099; } +body.bp a:visited { color: #000066; } +body.bp a:focus { color: black; } +body.bp a:hover { color: black; } +body.bp a:active { color: #cc0099; } +body.bp blockquote { margin: 1.5em; color: #666; font-style: italic; } +body.bp strong { font-weight: bold; } +body.bp em { font-style: italic; } +body.bp dfn { font-style: italic; font-weight: bold; } +body.bp sup, body.bp sub { line-height: 0; } +body.bp abbr, body.bp acronym { border-bottom: 1px dotted #666; } +body.bp address { margin: 0 0 1.5em; font-style: italic; } +body.bp del { color: #666; } +body.bp pre { margin: 1.5em 0; white-space: pre; } +body.bp pre, body.bp code, body.bp tt { font: 1em 'andale mono', 'lucida console', monospace; line-height: 1.5; } +body.bp li ul, body.bp li ol { margin: 0 1.5em; } +body.bp ul { margin: 0 1.5em 1.5em 1.5em; list-style-type: disc; } +body.bp ol { margin: 0 1.5em 1.5em 1.5em; list-style-type: decimal; } +body.bp dl { margin: 0 0 1.5em 0; } +body.bp dl dt { font-weight: bold; } +body.bp dd { margin-left: 1.5em; } +body.bp table { margin-bottom: 1.4em; width: 100%; } +body.bp th { font-weight: bold; } +body.bp thead th { background: #c3d9ff; } +body.bp th, body.bp td, body.bp caption { padding: 4px 10px 4px 5px; } +body.bp tr.even td { background: #e5ecf9; } +body.bp tfoot { font-style: italic; } +body.bp caption { background: #eee; } +body.bp .quiet { color: #666666; } +body.bp .loud { color: #111111; } + +body.bp .box { padding: 1.5em; margin-bottom: 1.5em; background: #E5ECF9; } +body.bp div.border { padding-right: 4px; margin-right: 5px; border-right: 1px solid #eeeeee; } +body.bp div.colborder { padding-right: 24px; margin-right: 25px; border-right: 1px solid #eeeeee; } +body.bp hr { background: #dddddd; color: #dddddd; clear: both; float: none; width: 100%; height: .1em; margin: 0 0 1.45em; border: none; } +body.bp hr.space { background: #dddddd; color: #dddddd; clear: both; float: none; width: 100%; height: .1em; margin: 0 0 1.45em; border: none; background: #fff; color: #fff; } + +body.bp .clear { clear: both; } +body.bp .nowrap { white-space: nowrap; } +body.bp .clearfix { overflow: hidden; display: inline-block; } +body.bp .clearfix { display: block; } +body.bp .small { font-size: .8em; margin-bottom: 1.875em; line-height: 1.875em; } +body.bp .large { font-size: 1.2em; line-height: 2.5em; margin-bottom: 1.25em; } +body.bp .first { margin-left: 0; padding-left: 0; } +body.bp .last { margin-right: 0; padding-right: 0; } +body.bp .top { margin-top: 0; padding-top: 0; } +body.bp .bottom { margin-bottom: 0; padding-bottom: 0; } +body.bp .showgrid { background: url('/images/grid.png?1267263512'); } +body.bp .error { padding: .8em; margin-bottom: 1em; border: 2px solid #dddddd; background: #fbe3e4; color: #8a1f11; border-color: #fbc2c4; } +body.bp .error a { color: #8a1f11; } +body.bp .notice { padding: .8em; margin-bottom: 1em; border: 2px solid #dddddd; background: #fff6bf; color: #514721; border-color: #ffd324; } +body.bp .notice a { color: #514721; } +body.bp .success { padding: .8em; margin-bottom: 1em; border: 2px solid #dddddd; background: #e6efc2; color: #264409; border-color: #c6d880; } +body.bp .success a { color: #264409; } +body.bp .hide { display: none; } +body.bp .highlight { background: yellow; } +body.bp .added { background: #006600; color: white; } +body.bp .removed { background: #990000; color: white; } + +form.bp label { font-weight: bold; } +form.bp fieldset { padding: 1.4em; margin: 0 0 1.5em 0; } +form.bp legend { font-weight: bold; font-size: 1.2em; } +form.bp input.text, form.bp input.title, form.bp input[type=text] { margin: 0.5em 0; background-color: #fff; padding: 5px; } +form.bp input.title { font-size: 1.5em; } +form.bp input[type=checkbox], form.bp input.checkbox, form.bp input[type=radio], form.bp input.radio { position: relative; top: 0.25em; } +form.bp textarea { margin: 0.5em 0; padding: 5px; } +form.bp select { margin: 0.5em 0; } +form.bp fieldset { border: 1px solid #cccccc; } +form.bp input.text, form.bp input.title, form.bp textarea, form.bp select { border: 1px solid #bbbbbb; } +form.bp input.text:focus, form.bp input.title:focus, form.bp textarea:focus, form.bp select:focus { border: 1px solid #666666; } +form.bp input.text, form.bp input.title { width: 300px; } +form.bp textarea { width: 390px; height: 250px; } + +body.three-col #container { width: 950px; margin: 0 auto; overflow: hidden; display: inline-block; } +body.three-col #container { display: block; } +body.three-col #header, body.three-col #footer { display: inline; float: left; margin-right: 10px; width: 950px; } +* html body.three-col #header, * html body.three-col #footer { overflow-x: hidden; } +body.three-col #sidebar { display: inline; float: left; margin-right: 10px; width: 310px; } +* html body.three-col #sidebar { overflow-x: hidden; } +body.three-col #content { display: inline; float: left; margin-right: 0; width: 630px; } +* html body.three-col #content { overflow-x: hidden; } diff --git a/templates/base.html b/templates/base.html index b63f684..49833b1 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,31 +1,36 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Demo Django & Compass</title> + <link href="/static/css/djangodemo/stylesheets/screen.css" media="screen, projection" rel="stylesheet" type="text/css" /> + <link href="/static/css/djangodemo/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" /> + <!--[if lt IE 8]> + <link href="/static/css/djangodemo/stylesheets/ie.css" media="screen, projection" rel="stylesheet" type="text/css" /> + <![endif]--> </head> <body> <div id="header"> <h1>Demo Django & Compass</h1> </div> <div id="menu"> <ul> <li><a href="/subjecten">Cliënten</a></li> </ul> </div> <div id="content"> {% block content %} <p>-</p> {% endblock %} </div> <div id="footer"> <ul> <li><a href="/">Home</a></li> <li><a href="#">About</a></li> <li><a href="#">Contact</a></li> <li>&copy;</li> </ul> </div> </body> </html> \ No newline at end of file diff --git a/urls.py b/urls.py index 5a17fc7..df499ef 100644 --- a/urls.py +++ b/urls.py @@ -1,26 +1,30 @@ from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns("django.views.generic.simple", # Hoofdpagina's (r'^$', "direct_to_template", {'template': 'index.html'}), ) urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), + + # Static media + # ONLY USE THIS FOR THE DEVELOPMENT SERVER. NEVER USE THIS IN PRODUCTION. + (r'^static/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/Users/berry/git/djangodemo/static'}), )
berry/Django-demo
77562deaf90e4099d100ba6699f0c55fd05a85e5
We have a first complet site. It is just not styled yet.
diff --git a/README.markdown b/README.markdown index afe772d..953a7ff 100644 --- a/README.markdown +++ b/README.markdown @@ -1,408 +1,498 @@ # Django & Compass gebruiken als een User Interaction Design tool By: Berry Groenendijk Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. * **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ## Onze eerste webpagina Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: berry$ touch subjecten/urls.py berry$ edit subjecten/urls.py En laat het als volgt uit zien: from django.conf.urls.defaults import * urlpatterns = patterns('djangodemo.subjecten.views', (r'^$', 'index'), (r'^(?P<subject_id>\d+)/$', 'detail'), ) In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), ) Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. Open het bestand subjecten/views.py en laat het er als volgt uit zien: from django.shortcuts import render_to_response from djangodemo.subjecten.models import Subject def index(request): '''Lijst van alle subjecten''' subjecten = Subject.objects.all() return render_to_response('subjecten/index.html', {'subjecten': subjecten}) def detail(request, subject_id): '''Details van een subject''' subject = Subject.objects.get(pk = subject_id) return render_to_response('subjecten/detail.html', {'subject': subject}) `render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. "/Users/berry/git/djangodemo/templates", ) Maak het bestand templates/subjecten/index.html: mkdir templates mkdir templates/subjecten touch templates/subjecten/index.html Laat templates/subjecten/index.html er als volgt uit zien: {% block content %} <table> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. Maak het bestand templates/subjecten/detail.html: touch templates/subjecten/detail.html Open dit bestand en laat het als volgt uit zien: {% block content %} <table> <tr> <td>Naam</td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> </tr> <tr> <td>Woonadres</td> <td></td> </tr> <tr> <td>Straat</td> <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} </td> </tr> <tr> <td>Postcode en woonplaats</td> <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} </td> </tr> </table> {% endblock content %} Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. +Maak het bestand templates/subjecten/base.html. Dit bestand gaat de basis html bevatten, laat het als volgt uit zien: + + <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" + "http://www.w3.org/TR/html4/strict.dtd"> + <html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>Demo Django & Compass</title> + </head> + <body> + <div id="header"> + <h1>Demo Django & Compass</h1> + </div> + <div id="menu"> + <ul> + <li><a href="/subjecten">Cliënten</a></li> + </ul> + </div> + <div id="content"> + {% block content %} + <p>-</p> + {% endblock %} + </div> + <div id="footer"> + <ul> + <li><a href="/">Home</a></li> + <li><a href="#">About</a></li> + <li><a href="#">Contact</a></li> + <li>&copy;</li> + </ul> + </div> + </body> + </html> + +Wees er zeker van dat je het bestand als UTF-8 opslaat. + +We hebben een nette HTML basis template met daarin een header block, een menu block, een content block en een footer block. Het content block heb ik ook voorzien van een Django template block aanduiding. + +Wijzig templates/subjecten/index.html en templates/subjecten/details.html en zet op de allereerste regel van deze twee bestanden: + + {% extends "base.html" %} + +Als je naar de subjecten pagina browsed dan zie je een complete HTML pagina met een titel, een menu en een footer. + +Wat we nog missen is een begin pagina voor onze site. Maak het bestand templates/index.html aan en laat het als volgt uit zien: + + {% extends "base.html" %} + + {% block content %} + <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen + dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> + {% endblock content %} + +Echter, we hebben nog geen url en nog geen view gedefinieerd. Dat gaan we dus ook even doen. Urls.py komt er als volgt uit te zien: + + from django.conf.urls.defaults import * + + # Uncomment the next two lines to enable the admin: + from django.contrib import admin + admin.autodiscover() + + urlpatterns = patterns("django.views.generic.simple", + + # Hoofdpagina's + (r'^$', "direct_to_template", {'template': 'index.html'}), + ) + + urlpatterns = urlpatterns + patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + # (r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), + + # Subjecten + (r'^subjecten/', include("djangodemo.subjecten.urls")), + ) + +We gebruiken hier een generic view genaamd `direct_to_template` waarmee je snel views in elkaar kan zetten. Er zijn meer generic views. O.a. een master-detail view. Die zullen we later gebruiken. + +We hebben nu een compleet werkende website! Alleen hij ziet er nog niet uit. Dat gaan we nu doen. We gaan de site opmaken. + +## De site vormgeven met behulp van Compass + + + ** waiting for more ** \ No newline at end of file diff --git a/templates/base.html b/templates/base.html new file mode 100644 index 0000000..b63f684 --- /dev/null +++ b/templates/base.html @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" + "http://www.w3.org/TR/html4/strict.dtd"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>Demo Django & Compass</title> + </head> + <body> + <div id="header"> + <h1>Demo Django & Compass</h1> + </div> + <div id="menu"> + <ul> + <li><a href="/subjecten">Cliënten</a></li> + </ul> + </div> + <div id="content"> + {% block content %} + <p>-</p> + {% endblock %} + </div> + <div id="footer"> + <ul> + <li><a href="/">Home</a></li> + <li><a href="#">About</a></li> + <li><a href="#">Contact</a></li> + <li>&copy;</li> + </ul> + </div> + </body> +</html> \ No newline at end of file diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..d8a3ac1 --- /dev/null +++ b/templates/index.html @@ -0,0 +1,6 @@ +{% extends "base.html" %} + +{% block content %} + <p>Welkom bij deze demo van Django & Compass waarin we proberen aan te tonen + dat deze combinatie een heel mooie User Interaction Design tool kan zijn.</p> +{% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/detail.html b/templates/subjecten/detail.html index 74c06ff..7eba656 100644 --- a/templates/subjecten/detail.html +++ b/templates/subjecten/detail.html @@ -1,22 +1,24 @@ +{% extends "base.html" %} + {% block content %} <table> <tr> <td>Naam</td> <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> </tr> <tr> <td>Woonadres</td> <td></td> </tr> <tr> <td>Straat</td> <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} </td> </tr> <tr> <td>Postcode en woonplaats</td> <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} </td> </tr> </table> {% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html index 14776ad..4245d0d 100644 --- a/templates/subjecten/index.html +++ b/templates/subjecten/index.html @@ -1,10 +1,12 @@ +{% extends "base.html" %} + {% block content %} <table> {% for subject in subjecten %} <tr> <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> <td>{{ subject.woonadres_woonplaats|upper }}</td> </tr> {% endfor %} </table> {% endblock content %} \ No newline at end of file diff --git a/urls.py b/urls.py index 48fad32..5a17fc7 100644 --- a/urls.py +++ b/urls.py @@ -1,20 +1,26 @@ from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() -urlpatterns = patterns('', +urlpatterns = patterns("django.views.generic.simple", + + # Hoofdpagina's + (r'^$', "direct_to_template", {'template': 'index.html'}), +) + +urlpatterns = urlpatterns + patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), # Subjecten (r'^subjecten/', include("djangodemo.subjecten.urls")), )
berry/Django-demo
d9fcf24fe7d3ddaa6b1d08046e1b67ce5192e8ac
Made a couple of views and our first templates for subjecten.
diff --git a/README.markdown b/README.markdown index 771cc21..afe772d 100644 --- a/README.markdown +++ b/README.markdown @@ -1,276 +1,408 @@ -# Django & Compass gebruiken als een User Interaction Design tool +# Django & Compass gebruiken als een User Interaction Design tool By: Berry Groenendijk Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). -In deze demo gaan we op basis van een probleemstelling idee‘n en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. +In deze demo gaan we op basis van een probleemstelling ideeën en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. * **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: -* subject, een cli‘nt die iets aanvragen bij de gemeente +* subject, een cliënt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. -* verstrekking, het product dat geleverd wordt aan de cli‘nt (bijv. een vergunning of een vergoeding) +* verstrekking, het product dat geleverd wordt aan de cliënt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. -Eerst nog wat initi‘le settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: +Eerst nog wat initiële settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten -We gaan onze eerste Django app maken en wel voor subjecten, de cli‘nten van een gemeente. Vanuit de djangodemo directory tik: +We gaan onze eerste Django app maken en wel voor subjecten, de cliënten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: #(r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. +## Onze eerste webpagina + +Webpagina's in Django worden gegenereerd door views. Een view is een type webpagina. In een view wordt data bij elkaar verzameld om op de webpagina te tonen. In een view wordt ook een template gedefinieerd. Data en template leiden tot een HTML pagina. Maar, je kan net zo goed ook XML, JSON, ASCII, etc. gegenereerd. + +Views worden gekoppeld aan een url via de urls.py. In urls.py ontwerp je de urls van de website. In Django ben je geheel vrij in het ontwerpen van de urls van je applicatie. + +Laten we eerst het url schema ontwerpen voor onze subjecten. Open subjecten/urls.py: + + berry$ touch subjecten/urls.py + berry$ edit subjecten/urls.py + +En laat het als volgt uit zien: + + from django.conf.urls.defaults import * + + urlpatterns = patterns('djangodemo.subjecten.views', + (r'^$', 'index'), + (r'^(?P<subject_id>\d+)/$', 'detail'), + ) + +In de hoofddirectory van de djangodemo staat de hoofd urls.py. Daar zullen we nog een verwijzing moeten maken naar de urls.py van subjecten. Open urls.py en laat het als volgt uit zien: + + from django.conf.urls.defaults import * + + # Uncomment the next two lines to enable the admin: + from django.contrib import admin + admin.autodiscover() + + urlpatterns = patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + # (r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), + + # Subjecten + (r'^subjecten/', include("djangodemo.subjecten.urls")), + ) + +Het leidt er toe dat de url `/subjecten` de methode index in djangodemo.subjecten.view aanroept. En dat bijvoorbeeld de url `/subjecten/10` de methode detail aanroept in de djangodemo.subjecten.views met de parameter 'subject_id' die in dit geval de waarde '10' heeft. + +Open het bestand subjecten/views.py en laat het er als volgt uit zien: + + from django.shortcuts import render_to_response + + from djangodemo.subjecten.models import Subject + + def index(request): + '''Lijst van alle subjecten''' + + subjecten = Subject.objects.all() + return render_to_response('subjecten/index.html', {'subjecten': subjecten}) + + def detail(request, subject_id): + '''Details van een subject''' + + subject = Subject.objects.get(pk = subject_id) + return render_to_response('subjecten/detail.html', {'subject': subject}) + +`render_to_response` is een hulpfunctie om snel een template plus een data dictionary samen te voegen en terug te geven aan de HTTP response. + +Als je nu naar http://127.0.0.1:8000/subjecten gaat dan zie je een foutmelding dat Django het template bestand niet kan vinden. De locatie van de templates staat in settings.py in de variabele `TEMPLATE_DIRS`. Open settings.py en wijzig `TEMPLATE_DIRS`in: + + TEMPLATE_DIRS = ( + # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". + # Always use forward slashes, even on Windows. + # Don't forget to use absolute paths, not relative paths. + "/Users/berry/git/djangodemo/templates", + ) + +Maak het bestand templates/subjecten/index.html: + + mkdir templates + mkdir templates/subjecten + touch templates/subjecten/index.html + +Laat templates/subjecten/index.html er als volgt uit zien: + + {% block content %} + <table> + {% for subject in subjecten %} + <tr> + <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> + <td>{{ subject.woonadres_woonplaats|upper }}</td> + </tr> + {% endfor %} + </table> + {% endblock content %} + +Browse naar http://127.0.0.1:8000/subjecten en voila onze eerste webpagina! + +En hier komt de grote kracht van Django naar voren. Als webdesigner ben je volledig vrij in het maken van de HTML. De template taal van Django is heel eenvoudig en door webdesigners te begrijpen. Een template kan dus gemaakt worden door een webdesigner. Daar hoeft geen programmeur aan te pas te komen. In de template taal wordt geen Python gebruikt. Je kunt als programmeur dan ook niet verleidt worden om te programmeren in de template. Code en HTML template zijn strict van elkaar gescheiden. + +De `{% %}` tags zijn stuur commando's zoals simpele for-loops of if-then constructies. De `{{ }}` tags zijn placeholders voor data. De template wordt gevoed met een data dictionary (zie ook de methode index eerder in het views.py bestand). In de data tags kun je 1 of meerdere filters gebruiken om de data op te maken. Bij woonplaats heb ik het filter upper gebruikt die de woonplaats in bovenkast plaatst. + +Maak het bestand templates/subjecten/detail.html: + + touch templates/subjecten/detail.html + +Open dit bestand en laat het als volgt uit zien: + +{% block content %} + <table> + <tr> + <td>Naam</td> + <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> + </tr> + <tr> + <td>Woonadres</td> + <td></td> + </tr> + <tr> + <td>Straat</td> + <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} + </td> + </tr> + <tr> + <td>Postcode en woonplaats</td> + <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} + </td> + </tr> + </table> +{% endblock content %} + +Dit is wel een hele eenvoudige weergave van een client. Maar goed, we zijn nog steeds aan het schetsen. We kunnen nu in de lijst van clienten klikken op een client en krijgen dan de details van de client te zien. De eerste contouren van een functionele en klikbare website ontstaan. + +We gaan nu nog een stukje van de kracht van Django templates zien: inheritance van templates. + ** waiting for more ** \ No newline at end of file diff --git a/settings.py b/settings.py index 373492f..83f8823 100644 --- a/settings.py +++ b/settings.py @@ -1,81 +1,82 @@ # Django settings for djangodemo project. DEBUG = True TEMPLATE_DEBUG = DEBUG ADMINS = ( # ('Your Name', '[email protected]'), ) MANAGERS = ADMINS DATABASE_ENGINE = 'django.db.backends.sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'. DATABASE_NAME = '/Users/berry/git/djangodemo/djangodemo_db' # Or path to database file if using sqlite3. DATABASE_USER = '' # Not used with sqlite3. DATABASE_PASSWORD = '' # Not used with sqlite3. DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3. DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3. # Local time zone for this installation. Choices can be found here: # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name # although not all choices may be available on all operating systems. # If running in a Windows environment this must be set to the same as your # system time zone. TIME_ZONE = 'America/Chicago' # Language code for this installation. All choices can be found here: # http://www.i18nguy.com/unicode/language-identifiers.html LANGUAGE_CODE = 'en-us' SITE_ID = 1 # If you set this to False, Django will make some optimizations so as not # to load the internationalization machinery. USE_I18N = True # Absolute path to the directory that holds media. # Example: "/home/media/media.lawrence.com/" MEDIA_ROOT = '' # URL that handles the media served from MEDIA_ROOT. Make sure to use a # trailing slash if there is a path component (optional in other cases). # Examples: "http://media.lawrence.com", "http://example.com/media/" MEDIA_URL = '' # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a # trailing slash. # Examples: "http://foo.com/media/", "/media/". ADMIN_MEDIA_PREFIX = '/media/' # Make this unique, and don't share it with anybody. SECRET_KEY = 'u*onq-80ifbru9^h-y)n$l^rd_yr(#low#!lh+m%x)jsgzywzr' # List of callables that know how to import templates from various sources. TEMPLATE_LOADERS = ( 'django.template.loaders.filesystem.load_template_source', 'django.template.loaders.app_directories.load_template_source', # 'django.template.loaders.eggs.load_template_source', ) MIDDLEWARE_CLASSES = ( 'django.middleware.common.CommonMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', ) ROOT_URLCONF = 'djangodemo.urls' TEMPLATE_DIRS = ( # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". # Always use forward slashes, even on Windows. # Don't forget to use absolute paths, not relative paths. + "/Users/berry/git/djangodemo/templates", ) INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) diff --git a/subjecten/urls.py b/subjecten/urls.py new file mode 100644 index 0000000..c61eb7c --- /dev/null +++ b/subjecten/urls.py @@ -0,0 +1,6 @@ +from django.conf.urls.defaults import * + +urlpatterns = patterns('djangodemo.subjecten.views', + (r'^$', 'index'), + (r'^(?P<subject_id>\d+)/$', 'detail'), +) \ No newline at end of file diff --git a/subjecten/views.py b/subjecten/views.py index 60f00ef..662671f 100644 --- a/subjecten/views.py +++ b/subjecten/views.py @@ -1 +1,16 @@ -# Create your views here. +from django.shortcuts import render_to_response + +from djangodemo.subjecten.models import Subject + +def index(request): + '''Lijst van alle subjecten''' + + subjecten = Subject.objects.all() + return render_to_response('subjecten/index.html', {'subjecten': subjecten}) + +def detail(request, subject_id): + '''Details van een subject''' + + subject = Subject.objects.get(pk = subject_id) + return render_to_response('subjecten/detail.html', {'subject': subject}) + \ No newline at end of file diff --git a/templates/subjecten/detail.html b/templates/subjecten/detail.html new file mode 100644 index 0000000..74c06ff --- /dev/null +++ b/templates/subjecten/detail.html @@ -0,0 +1,22 @@ +{% block content %} + <table> + <tr> + <td>Naam</td> + <td>{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</td> + </tr> + <tr> + <td>Woonadres</td> + <td></td> + </tr> + <tr> + <td>Straat</td> + <td>{{ subject.woonadres_straatnaam }} {{ subject.woonadres_huisnummer }} {{ subject.woonadres_huisnummer_toevoeging }} + </td> + </tr> + <tr> + <td>Postcode en woonplaats</td> + <td>{{ subject.woonadres_postcode|upper }} {{ subject.woonadres_woonplaats|upper }} + </td> + </tr> + </table> +{% endblock content %} \ No newline at end of file diff --git a/templates/subjecten/index.html b/templates/subjecten/index.html new file mode 100644 index 0000000..14776ad --- /dev/null +++ b/templates/subjecten/index.html @@ -0,0 +1,10 @@ +{% block content %} + <table> + {% for subject in subjecten %} + <tr> + <td><a href="/subjecten/{{ subject.id }}">{{ subject.voorletters }} {{ subject.tussenvoegsels }} {{ subject.achternaam }}</a></td> + <td>{{ subject.woonadres_woonplaats|upper }}</td> + </tr> + {% endfor %} + </table> +{% endblock content %} \ No newline at end of file diff --git a/urls.py b/urls.py index 9e09b86..48fad32 100644 --- a/urls.py +++ b/urls.py @@ -1,17 +1,20 @@ from django.conf.urls.defaults import * # Uncomment the next two lines to enable the admin: from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', # Example: # (r'^djangodemo/', include('djangodemo.foo.urls')), # Uncomment the admin/doc line below and add 'django.contrib.admindocs' # to INSTALLED_APPS to enable admin documentation: # (r'^admin/doc/', include('django.contrib.admindocs.urls')), # Uncomment the next line to enable the admin: (r'^admin/', include(admin.site.urls)), + + # Subjecten + (r'^subjecten/', include("djangodemo.subjecten.urls")), )
berry/Django-demo
f867d5f057266f3b3a91fcbc4cc463f529808698
Changed encoding of README.markdown to UTF-8
diff --git a/README.markdown b/README.markdown index b69141f..771cc21 100644 --- a/README.markdown +++ b/README.markdown @@ -1,276 +1,276 @@ # Django & Compass gebruiken als een User Interaction Design tool By: Berry Groenendijk Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling idee‘n en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. * **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cli‘nt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cli‘nt (bijv. een vergunning of een vergoeding) Voor onze eerste schets is dit voldoende informatie. ## We beginnen! Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" berry$ python Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) [GCC 4.0.1 (Apple Inc. build 5465)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import django >>> django.VERSION (1, 1, 1, 'final', 0) >>> Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. Ga naar je home directory en op je command prompt tik: berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo berry$ cd djangodemo/ berry$ ls __init__.py manage.py settings.py urls.py De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: python manage.py runserver Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. Eerst nog wat initi‘le settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: DATABASE_ENGINE = 'django.db.backends.sqlite3' DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: python manage.py syncdb Resultaat: berry$ python manage.py syncdb Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): yes Username (Leave blank to use 'berry'): berry E-mail address: [email protected] Password: Password (again): Superuser created successfully. Installing index for auth.Permission model Installing index for auth.Message model We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. ## Subjecten We gaan onze eerste Django app maken en wel voor subjecten, de cli‘nten van een gemeente. Vanuit de djangodemo directory tik: berry$ python manage.py startapp subjecten berry$ ls __init__.py djangodemo_db settings.py subjecten urls.pyc __init__.pyc manage.py settings.pyc urls.py berry$ cd subjecten/ berry$ ls __init__.py models.py views.py Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'djangodemo.subjecten', ) Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: python manage.py syncdb Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: INSTALLED_APPS = ( 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.admin', 'djangodemo.subjecten', ) Synchroniseer opnieuw de modellen met de database: python manage.py syncdb En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: -from django.conf.urls.defaults import * - -# Uncomment the next two lines to enable the admin: -from django.contrib import admin -admin.autodiscover() - - urlpatterns = patterns('', - # Example: - # (r'^djangodemo/', include('djangodemo.foo.urls')), + from django.conf.urls.defaults import * - # Uncomment the admin/doc line below and add 'django.contrib.admindocs' - # to INSTALLED_APPS to enable admin documentation: - #(r'^admin/doc/', include('django.contrib.admindocs.urls')), + # Uncomment the next two lines to enable the admin: + from django.contrib import admin + admin.autodiscover() - # Uncomment the next line to enable the admin: - (r'^admin/', include(admin.site.urls)), - ) + urlpatterns = patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + #(r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), + ) Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory touch subjecten/admin.py edit subjecten/admin.py Zorg dat subjecten/admin.py er als volgt uit ziet: from djangodemo.subjecten.models import Subject from django.contrib import admin admin.site.register(Subject) Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: touch settings.py Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: from django.db import models class Subject(models.Model): bsn = models.IntegerField('burger service nummer') achternaam = models.CharField(max_length=200) voorletters = models.CharField(max_length=15) tussenvoegsels = models.CharField(max_length=15) woonadres_straatnaam = models.CharField(max_length=200) woonadres_huisnummer = models.CharField(max_length=10) woonadres_huisnummer_toevoeging = models.CharField(max_length=10) woonadres_postcode = models.CharField(max_length=6) woonadres_woonplaats = models.CharField(max_length=200) correspondentie_straatnaam = models.CharField(max_length=200) correspondentie_huisnummer = models.CharField(max_length=10) correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) correspondentie_postcode = models.CharField(max_length=6) correspondentie_woonplaats = models.CharField(max_length=200) telefoonnummer = models.CharField(max_length=15) email = models.EmailField() class Meta: verbose_name_plural = "subjecten" def __unicode__(self): return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) -De __unicode__ functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. +De `__unicode__` functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. ** waiting for more ** \ No newline at end of file
berry/Django-demo
543d859c42af6500fb2529ca302b1e9d9dbfd09e
Demo is coming along. First model made, admin installed.
diff --git a/README.markdown b/README.markdown index dfbe9b0..b69141f 100644 --- a/README.markdown +++ b/README.markdown @@ -1,51 +1,276 @@ # Django & Compass gebruiken als een User Interaction Design tool By: Berry Groenendijk Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. Met deze demo hoop ik aan te geven dat het maken van een functioneel werkende schets van een website evenveel tijd kost als het maken van een traditioneel wireframe of statisch plaatje. Met als voordeel dat je op deze schets gewoon kunt voortborduren en de site kan uitbouwen tot een productierijpe website. ## Iteratief ontwikkelen Ik zie Django + Compass ook vooral als een manier om iteratief te ontwikkelen. Op het internet wordt regelmatig aan de hand van een plaatje van de Mona Lisa toegelicht wat het [verschil is tussen incrementeel en iteratief ontwikkelen](http://www.agileproductdesign.com/blog/dont_know_what_i_want.html). In deze demo gaan we op basis van een probleemstelling idee‘n en concepten uitwerken tot een eerste schets van een website. Maar, wel een werkende functionele, klikbare en zelfs testbare schets. Vanaf dat punt kun je telkens onderdelen van deze schets verder uitwerken en verbeteren. Op die manier wordt de website iteratief steeds beter. Uiteindelijk kun je de website, gebruikmakend van dezelfde technologie als waar je de schets mee gemaakt hebt, uitbouwen tot een volwaardige, productierijpe website die gebruikt kan worden door tientallen bezoekers maar ook 10-duizenden bezoekers. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. **TODO** aangeven hoe ik het geinstalleerd heb. * **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie ## Wat gaan we bouwen? -Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. De hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Iedere soort zaak kunnen verschillende statussen en stappen hebben. +Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. Die hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Verschillende soorten zaken kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cli‘nt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cli‘nt (bijv. een vergunning of een vergoeding) +Voor onze eerste schets is dit voldoende informatie. + ## We beginnen! -**TODO** \ No newline at end of file +Ik heb Django op een willekeurige plek op mijn harde schijf gezet. Ik heb Django in mijn home directory gezet. Even controleren of alles werkt. + + berry$ export PYTHONPATH="/Users/berry/Django-1.1.1/" + berry$ python + Python 2.5.1 (r251:54863, Feb 6 2009, 19:02:12) + [GCC 4.0.1 (Apple Inc. build 5465)] on darwin + Type "help", "copyright", "credits" or "license" for more information. + >>> import django + >>> django.VERSION + (1, 1, 1, 'final', 0) + >>> + +Gebruik CTRL+D om uit de Python prompt te komen. OK. We are ready to go. + +Ga naar je home directory en op je command prompt tik: + + berry$ ./Django-1.1.1/django/bin/django-admin.py startproject djangodemo + berry$ cd djangodemo/ + berry$ ls + __init__.py manage.py settings.py urls.py + +De projectdirectory is aangemaakt en een aantal standaard bestanden zijn aangemaakt. Het wordt zometeen duidelijk wat ze betekenen. + +Laten we eens kijken wat we gemaakt hebben. Vanuit de djangodemo directory tik: + + python manage.py runserver + +Browse naar http://127.0.0.1:8000/ en als het goed is zie je een Django welkom pagina met "It worked!". Deze server is absoluut niet bedoeld voor productie doeleinden, maar voor te ontwikkelen is ie prima. + +Eerst nog wat initi‘le settings aanpassen. Het configuratie bestand van Django is geen XML bestand of iets dergelijks maar gewoon een Python bestand. Heel gemakkelijk. Open het bestand settings.py. Wijzig de volgende variabelen naar: + + DATABASE_ENGINE = 'django.db.backends.sqlite3' + DATABASE_NAME = '/Users/berry/djangodemo/djangodemo_db' #pas dit aan naar een plek op je eigen harde schijf + +Open een nieuwe command prompt en ga naar de djangodemo directory. Op deze manier blijft de server gewoon draaien. Het mooie is dat deze developmentserver wijzigingen in de bestanden gewoon automatisch oppikt. Je hoeft de server niet te herstarten bij iedere wijziging. In de djangodemo directory tik: + + python manage.py syncdb + +Resultaat: + + berry$ python manage.py syncdb + Creating table auth_permission + Creating table auth_group + Creating table auth_user + Creating table auth_message + Creating table django_content_type + Creating table django_session + Creating table django_site + + You just installed Django's auth system, which means you don't have any superusers defined. + Would you like to create one now? (yes/no): yes + Username (Leave blank to use 'berry'): berry + E-mail address: [email protected] + Password: + Password (again): + Superuser created successfully. + Installing index for auth.Permission model + Installing index for auth.Message model + +We hebben nu een database aangemaakt en een aantal standaard tabellen zijn aangemaakt. + +## Subjecten + +We gaan onze eerste Django app maken en wel voor subjecten, de cli‘nten van een gemeente. Vanuit de djangodemo directory tik: + + berry$ python manage.py startapp subjecten + berry$ ls + __init__.py djangodemo_db settings.py subjecten urls.pyc + __init__.pyc manage.py settings.pyc urls.py + berry$ cd subjecten/ + berry$ ls + __init__.py models.py views.py + +Er is een subjecten directory aangemaakt. Het bestand models.py bevat het datamodel van de applicatie. Open het bestand models.py en tik het volgende in: + + from django.db import models + + class Subject(models.Model): + bsn = models.IntegerField('burger service nummer') + achternaam = models.CharField(max_length=200) + voorletters = models.CharField(max_length=15) + tussenvoegsels = models.CharField(max_length=15) + woonadres_straatnaam = models.CharField(max_length=200) + woonadres_huisnummer = models.CharField(max_length=10) + woonadres_huisnummer_toevoeging = models.CharField(max_length=10) + woonadres_postcode = models.CharField(max_length=6) + woonadres_woonplaats = models.CharField(max_length=200) + correspondentie_straatnaam = models.CharField(max_length=200) + correspondentie_huisnummer = models.CharField(max_length=10) + correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) + correspondentie_postcode = models.CharField(max_length=6) + correspondentie_woonplaats = models.CharField(max_length=200) + telefoonnummer = models.CharField(max_length=15) + email = models.EmailField() + +Dit model is niet compleet en de decompositie is niet goed. Maar, dat doet er op dit moment niet toe. We zijn nog alleen maar aan het schetsen. We verzamelen de gegevens die opgeslagen moeten worden bij de business en brengen die onder in een model. + +We voegen de applicatie subjecten toe aan de settings.py file dusdanig dat INSTALLED_APPS er als volgt uit ziet: + + INSTALLED_APPS = ( + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.sites', + 'djangodemo.subjecten', + ) + +Van het model dienen sql statements gemaakt te worden en op de database toegepast te worden. Dat kan met het volgende commando: + + python manage.py syncdb + +Zou het niet handig zijn om nu te kijken hoe de database eruit ziet en dat we alvast wat data kunnen invullen? Dat gaan we nu dan ook doen. + +Django kent een app genaamd Admin. Hiermee kun je de database beheren. We dienen de admin app toe te voegen aan de lijst van apps in de settings.py. Open settings.py en zorg er voor dat INSTALLED_APPS er als volgt uit ziet: + + INSTALLED_APPS = ( + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.sites', + 'django.contrib.admin', + 'djangodemo.subjecten', + ) + +Synchroniseer opnieuw de modellen met de database: + + python manage.py syncdb + +En als laatste dienen we de admin app aan de urls.py toe te voegen. Urls.py bevat het url schema van je applicatie. Het url schema is feite een koppeling tussen een url en de code die de html gaat genereren. Daarover later meer. Haal het commentaar teken, #, weg bij de aangegeven regels in het urls.py bestand zodat het er als volgt uit ziet: + +from django.conf.urls.defaults import * + +# Uncomment the next two lines to enable the admin: +from django.contrib import admin +admin.autodiscover() + + urlpatterns = patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + #(r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), + ) + +Browse naar http://127.0.0.1:8000/admin. Je krijgt nu een login venster te zien voor het admin scherm. Je ziet een aantal tabellen, maar nog niet de tabellen van subjecten. Dat gaan we veranderen. Maak een bestand admin.py in de subjecten directory + + touch subjecten/admin.py + edit subjecten/admin.py + +Zorg dat subjecten/admin.py er als volgt uit ziet: + + from djangodemo.subjecten.models import Subject + from django.contrib import admin + + admin.site.register(Subject) + +Browse naar http://127.0.0.1/admin. Als je nu de tabel subjecten nog niet ziet, herstart dan even de ontwikkelserver. De ontwikkelserver herkent niet automatisch nieuwe bestanden. Je kan ook eventueel het volgende commando uitvoeren: + + touch settings.py + +Onder het kopje subjecten staat de tabel subjects genoemd. Hmmm, subjects is in het Nederland niet het meervoud van subject. Dat gaan we veranderen. Wijzig subjecten/models.py naar: + + from django.db import models + + class Subject(models.Model): + bsn = models.IntegerField('burger service nummer') + achternaam = models.CharField(max_length=200) + voorletters = models.CharField(max_length=15) + tussenvoegsels = models.CharField(max_length=15) + woonadres_straatnaam = models.CharField(max_length=200) + woonadres_huisnummer = models.CharField(max_length=10) + woonadres_huisnummer_toevoeging = models.CharField(max_length=10) + woonadres_postcode = models.CharField(max_length=6) + woonadres_woonplaats = models.CharField(max_length=200) + correspondentie_straatnaam = models.CharField(max_length=200) + correspondentie_huisnummer = models.CharField(max_length=10) + correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) + correspondentie_postcode = models.CharField(max_length=6) + correspondentie_woonplaats = models.CharField(max_length=200) + telefoonnummer = models.CharField(max_length=15) + email = models.EmailField() + + class Meta: + verbose_name_plural = "subjecten" + +In de innerclass Meta voegen we een attribuut verbose_name_plural toe. Hierin geven we aan wat de meervouds vorm van de class name is. Bekijk de admin opnieuw en je ziet dat de tabelnaam gewijzigd is. In de admin kunnen we nu simpel data toevoegen aan de tabel subjecten. Voeg twee subjecten in. Verzin simpelweg wat data. + +Er vallen een aantal dingen op. Alle velden zijn verplicht. Dit is aan te passen, maar dat doen we later. Ieder object heet "Subject object". Dat laatste gaan we veranderen want dat ziet er vervelend uit. Wijzig subjecten/models.py naar: + + from django.db import models + + class Subject(models.Model): + bsn = models.IntegerField('burger service nummer') + achternaam = models.CharField(max_length=200) + voorletters = models.CharField(max_length=15) + tussenvoegsels = models.CharField(max_length=15) + woonadres_straatnaam = models.CharField(max_length=200) + woonadres_huisnummer = models.CharField(max_length=10) + woonadres_huisnummer_toevoeging = models.CharField(max_length=10) + woonadres_postcode = models.CharField(max_length=6) + woonadres_woonplaats = models.CharField(max_length=200) + correspondentie_straatnaam = models.CharField(max_length=200) + correspondentie_huisnummer = models.CharField(max_length=10) + correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) + correspondentie_postcode = models.CharField(max_length=6) + correspondentie_woonplaats = models.CharField(max_length=200) + telefoonnummer = models.CharField(max_length=15) + email = models.EmailField() + + class Meta: + verbose_name_plural = "subjecten" + + def __unicode__(self): + return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) + +De __unicode__ functie wordt aangeroepen als de print functie van de class wordt aangeroepen. In de admin verschijnen nu de namen van de subjecten. Mooi zo. + +Even terugkijken. We hebben een datamodel aangemaakt, de admin interface geactiveerd en wat data ingevoerd. Netjes. Laten we nu een heuse echt pagina gaan maken voor de website. + +** waiting for more ** \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/djangodemo_db b/djangodemo_db new file mode 100644 index 0000000..62353ae Binary files /dev/null and b/djangodemo_db differ diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..5e78ea9 --- /dev/null +++ b/manage.py @@ -0,0 +1,11 @@ +#!/usr/bin/env python +from django.core.management import execute_manager +try: + import settings # Assumed to be in the same directory. +except ImportError: + import sys + sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__) + sys.exit(1) + +if __name__ == "__main__": + execute_manager(settings) diff --git a/settings.py b/settings.py new file mode 100644 index 0000000..373492f --- /dev/null +++ b/settings.py @@ -0,0 +1,81 @@ +# Django settings for djangodemo project. + +DEBUG = True +TEMPLATE_DEBUG = DEBUG + +ADMINS = ( + # ('Your Name', '[email protected]'), +) + +MANAGERS = ADMINS + +DATABASE_ENGINE = 'django.db.backends.sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'. +DATABASE_NAME = '/Users/berry/git/djangodemo/djangodemo_db' # Or path to database file if using sqlite3. +DATABASE_USER = '' # Not used with sqlite3. +DATABASE_PASSWORD = '' # Not used with sqlite3. +DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3. +DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3. + +# Local time zone for this installation. Choices can be found here: +# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name +# although not all choices may be available on all operating systems. +# If running in a Windows environment this must be set to the same as your +# system time zone. +TIME_ZONE = 'America/Chicago' + +# Language code for this installation. All choices can be found here: +# http://www.i18nguy.com/unicode/language-identifiers.html +LANGUAGE_CODE = 'en-us' + +SITE_ID = 1 + +# If you set this to False, Django will make some optimizations so as not +# to load the internationalization machinery. +USE_I18N = True + +# Absolute path to the directory that holds media. +# Example: "/home/media/media.lawrence.com/" +MEDIA_ROOT = '' + +# URL that handles the media served from MEDIA_ROOT. Make sure to use a +# trailing slash if there is a path component (optional in other cases). +# Examples: "http://media.lawrence.com", "http://example.com/media/" +MEDIA_URL = '' + +# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a +# trailing slash. +# Examples: "http://foo.com/media/", "/media/". +ADMIN_MEDIA_PREFIX = '/media/' + +# Make this unique, and don't share it with anybody. +SECRET_KEY = 'u*onq-80ifbru9^h-y)n$l^rd_yr(#low#!lh+m%x)jsgzywzr' + +# List of callables that know how to import templates from various sources. +TEMPLATE_LOADERS = ( + 'django.template.loaders.filesystem.load_template_source', + 'django.template.loaders.app_directories.load_template_source', +# 'django.template.loaders.eggs.load_template_source', +) + +MIDDLEWARE_CLASSES = ( + 'django.middleware.common.CommonMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', +) + +ROOT_URLCONF = 'djangodemo.urls' + +TEMPLATE_DIRS = ( + # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". + # Always use forward slashes, even on Windows. + # Don't forget to use absolute paths, not relative paths. +) + +INSTALLED_APPS = ( + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.sites', + 'django.contrib.admin', + 'djangodemo.subjecten', +) diff --git a/subjecten/__init__.py b/subjecten/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/subjecten/admin.py b/subjecten/admin.py new file mode 100644 index 0000000..973c2a5 --- /dev/null +++ b/subjecten/admin.py @@ -0,0 +1,4 @@ +from djangodemo.subjecten.models import Subject +from django.contrib import admin + +admin.site.register(Subject) diff --git a/subjecten/models.py b/subjecten/models.py new file mode 100644 index 0000000..16e03c6 --- /dev/null +++ b/subjecten/models.py @@ -0,0 +1,25 @@ +from django.db import models + +class Subject(models.Model): + bsn = models.IntegerField('burger service nummer') + achternaam = models.CharField(max_length=200) + voorletters = models.CharField(max_length=15) + tussenvoegsels = models.CharField(max_length=15) + woonadres_straatnaam = models.CharField(max_length=200) + woonadres_huisnummer = models.CharField(max_length=10) + woonadres_huisnummer_toevoeging = models.CharField(max_length=10) + woonadres_postcode = models.CharField(max_length=6) + woonadres_woonplaats = models.CharField(max_length=200) + correspondentie_straatnaam = models.CharField(max_length=200) + correspondentie_huisnummer = models.CharField(max_length=10) + correspondentie_huisnummer_toevoeging = models.CharField(max_length=10) + correspondentie_postcode = models.CharField(max_length=6) + correspondentie_woonplaats = models.CharField(max_length=200) + telefoonnummer = models.CharField(max_length=15) + email = models.EmailField() + + class Meta: + verbose_name_plural = "subjecten" + + def __unicode__(self): + return "%s %s %s" % (self.voorletters, self.tussenvoegsels, self.achternaam) \ No newline at end of file diff --git a/subjecten/views.py b/subjecten/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/subjecten/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/urls.py b/urls.py new file mode 100644 index 0000000..9e09b86 --- /dev/null +++ b/urls.py @@ -0,0 +1,17 @@ +from django.conf.urls.defaults import * + +# Uncomment the next two lines to enable the admin: +from django.contrib import admin +admin.autodiscover() + +urlpatterns = patterns('', + # Example: + # (r'^djangodemo/', include('djangodemo.foo.urls')), + + # Uncomment the admin/doc line below and add 'django.contrib.admindocs' + # to INSTALLED_APPS to enable admin documentation: + # (r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + (r'^admin/', include(admin.site.urls)), +)
berry/Django-demo
0e8da706510f0f2139c704af38bafe33d65a3381
Small error in readme fixed. And removed email address.
diff --git a/README.markdown b/README.markdown index 15ac6e6..c0ba43b 100644 --- a/README.markdown +++ b/README.markdown @@ -1,40 +1,41 @@ # Django & Compass gebruiken als een User Interaction Design tool -By: [email protected] +By: Berry Groenendijk + Date: 25 february 2010 ## Language This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. ## Doel Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. -Ik denk dat je zo'n website in evenveel tijd kan bouwen als een tradiotionele wireframe. Ook beweer ik dat zo'n website net zo aanpasbaar is. +Ik denk dat je zo'n website in evenveel tijd kan bouwen als een traditionele wireframe. Ook beweer ik dat zo'n website net zo aanpasbaar is. ## Benodigdheden Je hebt de volgende software nodig. * [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. * [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. Volg de installatie instructies onder optie 1. * **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie ## Wat gaan we bouwen? Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. De hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Iedere soort zaak kunnen verschillende statussen en stappen hebben. We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: * subject, een cli‘nt die iets aanvragen bij de gemeente * zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. * verstrekking, het product dat geleverd wordt aan de cli‘nt (bijv. een vergunning of een vergoeding) ## We beginnen! **TODO** \ No newline at end of file
berry/Django-demo
c743c628bf25b613b1770f56ff8812d7e52c1852
Wrote first part of README.
diff --git a/README b/README index e69de29..15ac6e6 100644 --- a/README +++ b/README @@ -0,0 +1,40 @@ +# Django & Compass gebruiken als een User Interaction Design tool + +By: [email protected] +Date: 25 february 2010 + +## Language + +This demo is targeted at a Dutch audience. So I will switch to Dutch. Now. + +## Doel + +Ik gebruik al een tijdlang Django en heb sinds kort Compass ontdekt. Compass is een stylesheet authoring framework. En toen vroeg ik mij het volgende af. Django & Compass vormen tezamen een geweldige tool voor het ontwerpen van website schermen (User Interaction Design). + +In plaats van papieren ontwerpen, zg. wireframes, Photoshop plaatjes of Firework plaatjes, kun je een compleet functionele en dus klikbare website maken met behulp van Django. En met behulp van Compass kun de site heel snel vormgeven. + +Ik denk dat je zo'n website in evenveel tijd kan bouwen als een tradiotionele wireframe. Ook beweer ik dat zo'n website net zo aanpasbaar is. + +## Benodigdheden + +Je hebt de volgende software nodig. + +* [Python](http://python.org/), reeds aanwezig op Mac OS X, Linux, etc. Op Windows dien je het nog te installeren. + +* [Django](http://www.djangoproject.com/download/). Ik heb voor de demo Django 1.1.1 gebruikt. Volg de installatie instructies onder optie 1. + +* **TODO** [Compass](http://wiki.github.com/chriseppstein/compass/getting-started) installatie + +## Wat gaan we bouwen? + +Bij met name Nederlandse gemeenten wordt [zaakgericht werken](http://www.zaakgerichtwerken.nl/) gepropageerd. Wat is het? Burgers vragen bij hun gemeente allerlei zaken aan. Zoals bijv. een vergunning. De gemeente voert hiervoor een aantal handelingen uit. De hoeveelheid werk wordt een zaak genoemd. Iedere zaak kent een aantal stappen en statussen. Iedere soort zaak kunnen verschillende statussen en stappen hebben. + +We gaan een website bouwen die gebruikt wordt door ambtenaren om zaken mee af te handelen. Het domein kent globaal de volgende objecten: + +* subject, een cli‘nt die iets aanvragen bij de gemeente +* zaak, een hoeveelheid werk die middels stappen en statussen af te handelen is en te volgen is. +* verstrekking, het product dat geleverd wordt aan de cli‘nt (bijv. een vergunning of een vergoeding) + +## We beginnen! + +**TODO** \ No newline at end of file
dantman/wrench
4d7169b4e44037858b70007476823066bdb489ba
Change isObject definitions. Now isObject just tests if something is an object genericly, it is not for testing for literals. New method isObjectLiteral instead takes that place based off of jQuery's isOPlainObject method. Previously isObject had different behaviours between wrench15 and wrench17, we now use the same methods on all of them.
diff --git a/src/extras/Functions.js b/src/extras/Functions.js index bc31b3d..61c7eb6 100644 --- a/src/extras/Functions.js +++ b/src/extras/Functions.js @@ -1,23 +1,53 @@ -(function(toString) { +(function(toString, hasOwnProperty) { + var global = this; - this.isString = function isString(str) { + global.isString = function isString(str) { return typeof str === 'string' || toString.call(str) === '[object String]'; }; - - this.isNumber = function isNumber(num) { + + global.isNumber = function isNumber(num) { return typeof num === 'number' || toString.call(num) === '[object Number]'; }; - - this.isArray = Array.isArray; - - this.isObject = function isObject(obj) { + + global.isArray = Array.isArray; + + global.isObject = function isObject(obj) { return toString.call(obj) === '[object Object]'; }; + + // Based on jQuery.isPlainObject with some local improvements to the tests + global.isObjectLiteral = function(obj) { + // Must be an Object. + // Because of IE, we also have to check the presence of the constructor property. + if ( !obj || toString.call(obj) !== "[object Object]" ) { + return false; + } + + // Make sure that window objects don't pass through + // In IE setTimeout isn't a function, however it doesn't have a valid constructor so we can special case it + if ( isFunction(obj.setTimeout) || ( isObject(obj.setTimeout) && obj.setTimeout.constructor === undefined ) ) { + return false; + } - this.isFunction = function isFunction(fn) { + // Not own constructor property must be Object and can't have a toString of type "unknown" (DOM nodes in IE) + if ( obj.constructor + && !hasOwnProperty.call(obj, "constructor") + && !hasOwnProperty.call(obj.constructor.prototype, "isPrototypeOf" + && typeof obj.constructor.toString !== "unknown") ) { + return false; + } + + // Own properties are enumerated firstly, so to speed up, + // if last one is own, then all properties are own. + var key; + for ( key in obj ) {} + return key === undefined || hasOwnProperty.call(obj, key); + }; + + global.isFunction = function isFunction(fn) { return toString.call(fn) === '[object Function]'; }; -}).call(this, Object.prototype.toString); +}).call(this, Object.prototype.toString, Object.prototype.hasOwnProperty);
dantman/wrench
2fd9781e0f6943c32c0f12c52f3206a62eb54b7d
Fix Object.count to only do the test the first time.
diff --git a/src/extras/Object.js b/src/extras/Object.js index 0e1c5ed..8e7c71b 100644 --- a/src/extras/Object.js +++ b/src/extras/Object.js @@ -1,72 +1,73 @@ /** * @fileOverview This file contains new methods for the Object class */ /** * @name Object * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. */ /** * Returns a new object with the passed object's keys as the new object's values * and the passed object's values as the keys to those values. * * @param {Object} obj The object to create an inverted object from * @return {Object} The inverted object */ Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; /** * Merges multiple objects together into the first object with a right dominant pattern. * This will modify the first object and override methods with the rightmost value. * * This method returns the object that was modified, so if you would like a new * object instead of one of your objects being overwritten use `Object.merge({}, ...);` * * @param {Boolean} [deep=false] Use a deep object merge * @param {Object} obj Object to merge into * @param {Object} ...objs Objects to merge into obj * @return {Object} The first object passed to merge */ Object.merge = function merge() { var a = Array.slice(arguments), left, deep = false; if ( typeof a[0] === 'boolean' ) deep = a.shift(); left = a.shift(); if ( left === null || typeof left !== 'object' ) throw new TypeError(); for ( var i = 0, l = a.length; i<l; i++ ) { var right = a[i]; for ( var key in right ) { if ( right.hasOwnProperty(key) ) { if ( deep && isObject(right[key]) ) { if ( !isObject(left[key]) ) left[key] = {}; left[key] = merge( true, left[key], right[key] ); } else { left[key] = right[key]; } } } } return left; }; /** * Return the number of key/value pairs within an object * * @param {Object} obj The object to count * @return {Number} The number of pairs in the object */ -(function(useCount) { - Object.count = function count(obj) { - if ( useCount ) return obj.__count__; +Object.count = ({}).__count__ === 0 ? + function(obj) { + return obj.__count__; + } : + function(obj) { return Object.keys(obj).length; }; -})(({}).__count__ === 0);
dantman/wrench
2f3f7cadb3ee9e5333d8acd7c57e77b0e026d724
Move functions to separate es5 and extras folders.
diff --git a/src/Functions.browser.js b/src/Functions.browser.js deleted file mode 100644 index 962c776..0000000 --- a/src/Functions.browser.js +++ /dev/null @@ -1,49 +0,0 @@ - -/** - * ES5: Returns the prototype for this instance - * - * @see // http://ejohn.org/blog/objectgetprototypeof/#js-4 - * - * @name getPrototypeOf - * @methodOf Object - * - * @param {Object} object The object to get the protoype of - * @return {Objedct} The object's prototype - */ -if (!Object.getPrototypeOf) { - if ( typeof "test".__proto__ === "object" ) { - Object.getPrototypeOf = function(object) { - return object.__proto__; - }; - } else { - Object.getPrototypeOf = function(object){ - // May break if the constructor has been tampered with - return object.constructor.prototype; - }; - } -} - -(function(toString) { - - this.isString = function isString(str) { - return typeof str === 'string' || toString.call(str) === '[object String]'; - }; - - this.isNumber = function isNumber(num) { - return typeof num === 'number' || toString.call(num) === '[object Number]'; - }; - - this.isArray = function isArray(arr) { - return toString.call(arr) === '[object Array]'; - }; - - this.isObject = function isObject(obj) { - return toString.call(obj) === '[object Object]'; - }; - - this.isFunction = function isFunction(fn) { - return toString.call(fn) === '[object Function]'; - }; - -}).call(this, Object.prototype.toString); - diff --git a/src/Functions.js b/src/Functions.js deleted file mode 100644 index 8bbff81..0000000 --- a/src/Functions.js +++ /dev/null @@ -1,26 +0,0 @@ - -if ( !Object.getPrototypeOf ) - Object.getPrototypeOf = function(obj) { - return obj.__proto__; - }; - -function isString(str) { - return typeof str === 'string' || str instanceof String; -} - -function isNumber(num) { - return typeof num === 'number' || num instanceof Number; -} - -function isArray(arr) { - return arr instanceof Array; -} - -function isObject(obj) { - return obj !== null && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype; -} - -function isFunction(fn) { - return typeof fn === 'function' && Object.getPrototypeOf(fn) === Function.prototype; -} - diff --git a/src/es5/Functions.js b/src/es5/Functions.js new file mode 100644 index 0000000..ebf3536 --- /dev/null +++ b/src/es5/Functions.js @@ -0,0 +1,30 @@ + +/** + * ES5: Returns the prototype for this instance + * + * @see // http://ejohn.org/blog/objectgetprototypeof/#js-4 + * + * @name getPrototypeOf + * @methodOf Object + * + * @param {Object} object The object to get the protoype of + * @return {Object} The object's prototype + */ +if ( !Object.getPrototypeOf ) { + if ( typeof "test".__proto__ === "object" ) { + Object.getPrototypeOf = function(object) { + return object.__proto__; + }; + } else { + Object.getPrototypeOf = function(object){ + // May break if the constructor has been tampered with + return object.constructor.prototype; + }; + } +} + +if ( !Array.isArray ) + Array.isArray = function(arr) { + return Object.prototype.toString.call(arr) === '[object Array]'; + }; + diff --git a/src/extras/Functions.js b/src/extras/Functions.js new file mode 100644 index 0000000..bc31b3d --- /dev/null +++ b/src/extras/Functions.js @@ -0,0 +1,23 @@ + +(function(toString) { + + this.isString = function isString(str) { + return typeof str === 'string' || toString.call(str) === '[object String]'; + }; + + this.isNumber = function isNumber(num) { + return typeof num === 'number' || toString.call(num) === '[object Number]'; + }; + + this.isArray = Array.isArray; + + this.isObject = function isObject(obj) { + return toString.call(obj) === '[object Object]'; + }; + + this.isFunction = function isFunction(fn) { + return toString.call(fn) === '[object Function]'; + }; + +}).call(this, Object.prototype.toString); +
dantman/wrench
2d40e8ae1b64f49844126df4440771991887818f
Start separating methods into subfolders.
diff --git a/Makefile b/Makefile index 79f9199..9cc7d0d 100644 --- a/Makefile +++ b/Makefile @@ -1,143 +1,150 @@ SRC_DIR = ./src BUILD_DIR = ./build DOC_DIR = ./doc DIST_DIR = ./dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Function.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/String.js +FILES_ES5 = ${SRC_DIR}/top.txt\ + ${SRC_DIR}/es5/Object.js\ + ${SRC_DIR}/es5/Date.js\ + ${SRC_DIR}/es5/String.js\ + ${SRC_DIR}/js16/Array.js\ + ${SRC_DIR}/js18/Array.js + FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar TAR_NAME = wrench-${WRENCH_VER}.tar.gz ZIP_NAME = wrench-${WRENCH_VER}.zip all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ test15: all cd test; java -jar ../build/js.jar test15.js test17: all cd test; java -jar ../build/js.jar -version 170 test17.js # Distribution ${DIST_DIR}/build: ${DIST_DIR} -@@mkdir ${DIST_DIR}/build ${DIST_DIR}/src: ${DIST_DIR} -@@mkdir ${DIST_DIR}/src ${DIST_DIR}/src/*: ${DIST_DIR}/src ${SRC_DIR}/* @@cp ${SRC_DIR}/* ${DIST_DIR}/src/ ${DIST_DIR}/build/js.jar: ${DIST_DIR}/build ${BUILD_DIR}/js.jar @@cp ${BUILD_DIR}/js.jar ${DIST_DIR}/build/ ${DIST_DIR}/build/yuicompressor-2.4.2.jar: ${DIST_DIR}/build ${BUILD_DIR}/yuicompressor-2.4.2.jar @@cp ${BUILD_DIR}/yuicompressor-2.4.2.jar ${DIST_DIR}/build/ ${DIST_DIR}/Makefile: ./Makefile @@cp ./Makefile ${DIST_DIR} ${DIST_DIR}/README: ./README @@cp ./README ${DIST_DIR} ${DIST_DIR}/version.txt: ./version.txt @@cp ./version.txt ${DIST_DIR} ${DIST_DIR}/test: ./test ./test/* ./test/tests/* @@cp -r ./test ${DIST_DIR} ${DIST_DIR}/doc: docs @@cp -r ${DOC_DIR} ${DIST_DIR} # Note: doc/ is not yet ready for packaging. It uses absolute references to monkeyscript.org for some static components. build-dist: all ${DIST_DIR}/src/* ${DIST_DIR}/build/js.jar ${DIST_DIR}/build/yuicompressor-2.4.2.jar ${DIST_DIR}/Makefile ${DIST_DIR}/README ${DIST_DIR}/version.txt ${DIST_DIR}/test ${DIST_DIR}/doc @@cd ${DIST_DIR}; tar -czf ${TAR_NAME} --exclude=${TAR_NAME} --exclude=${ZIP_NAME} * @@cd ${DIST_DIR}; zip -rqn ".jar" ${ZIP_NAME} . -x ${TAR_NAME} -x ${ZIP_NAME} @@- mv "${DIST_DIR}/wrench15.js" "${DIST_DIR}/wrench15-${WRENCH_VER}.js" @@- mv "${DIST_DIR}/wrench15.min.js" "${DIST_DIR}/wrench15-${WRENCH_VER}.min.js" @@- mv "${DIST_DIR}/wrench17.js" "${DIST_DIR}/wrench17-${WRENCH_VER}.js" @@- mv "${DIST_DIR}/wrench18.js" "${DIST_DIR}/wrench18-${WRENCH_VER}.js" @@echo "Wrench distribution build complete." diff --git a/src/isodate.js b/src/es5/Date.js similarity index 100% rename from src/isodate.js rename to src/es5/Date.js diff --git a/src/es5/Object.js b/src/es5/Object.js new file mode 100644 index 0000000..28afca8 --- /dev/null +++ b/src/es5/Object.js @@ -0,0 +1,38 @@ +/** + * @fileOverview This file contains es5 compat methods for the Object class + */ +/** + * @name Object + * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. + */ + +/** + * Return an array containing the list of keys within the object + * + * @param {Object} obj The object to take keys from + * @return {Array} The array of keys + */ +if ( !Object.keys ) + Object.keys = function keys(obj) { + var keys = []; + for ( var k in obj ) + if ( obj.hasOwnProperty( k ) ) + keys.push( k ); + return keys; + }; + +/** + * Return an array containing the list of values within the object + * + * @param {Object} obj The object to take values from + * @return {Array} The array of values + */ +if ( !Object.values ) + Object.values = function values(obj) { + var values = []; + for ( var k in obj ) + if ( obj.hasOwnProperty( k ) ) + values.push( obj[k] ); + return values; + }; + diff --git a/src/es5/String.js b/src/es5/String.js new file mode 100644 index 0000000..356eb47 --- /dev/null +++ b/src/es5/String.js @@ -0,0 +1,19 @@ +/** + * @fileOverview This file contains es5 compat methods for the String class + */ +/** + * @name String + * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. + */ + +/** + * Trim all whitespace from both sides of the string + * Native to js1.8.1 and es5 + * + * @return {String} The new trimmed string + */ +if ( !String.prototype.trim ) + String.prototype.trim = function trim() { + return this.replace(/^\s\s*/, '').replace(/\s*\s*$/, ''); + }; + diff --git a/src/Array.iterator.js b/src/extras/Array.iterator.js similarity index 100% rename from src/Array.iterator.js rename to src/extras/Array.iterator.js diff --git a/src/Array.js b/src/extras/Array.js similarity index 100% rename from src/Array.js rename to src/extras/Array.js diff --git a/src/Array.new.js b/src/extras/Array.new.js similarity index 100% rename from src/Array.new.js rename to src/extras/Array.new.js diff --git a/src/Array.old.js b/src/extras/Array.old.js similarity index 100% rename from src/Array.old.js rename to src/extras/Array.old.js diff --git a/src/Function.js b/src/extras/Function.js similarity index 100% rename from src/Function.js rename to src/extras/Function.js diff --git a/src/Getters.js b/src/extras/Getters.js similarity index 100% rename from src/Getters.js rename to src/extras/Getters.js diff --git a/src/Math.js b/src/extras/Math.js similarity index 100% rename from src/Math.js rename to src/extras/Math.js diff --git a/src/Number.js b/src/extras/Number.js similarity index 100% rename from src/Number.js rename to src/extras/Number.js diff --git a/src/Object.js b/src/extras/Object.js similarity index 75% rename from src/Object.js rename to src/extras/Object.js index ad4066f..0e1c5ed 100644 --- a/src/Object.js +++ b/src/extras/Object.js @@ -1,102 +1,72 @@ /** * @fileOverview This file contains new methods for the Object class */ /** * @name Object * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. */ /** * Returns a new object with the passed object's keys as the new object's values * and the passed object's values as the keys to those values. * * @param {Object} obj The object to create an inverted object from * @return {Object} The inverted object */ Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; /** * Merges multiple objects together into the first object with a right dominant pattern. * This will modify the first object and override methods with the rightmost value. * * This method returns the object that was modified, so if you would like a new * object instead of one of your objects being overwritten use `Object.merge({}, ...);` * * @param {Boolean} [deep=false] Use a deep object merge * @param {Object} obj Object to merge into * @param {Object} ...objs Objects to merge into obj * @return {Object} The first object passed to merge */ Object.merge = function merge() { var a = Array.slice(arguments), left, deep = false; if ( typeof a[0] === 'boolean' ) deep = a.shift(); left = a.shift(); if ( left === null || typeof left !== 'object' ) throw new TypeError(); for ( var i = 0, l = a.length; i<l; i++ ) { var right = a[i]; for ( var key in right ) { if ( right.hasOwnProperty(key) ) { if ( deep && isObject(right[key]) ) { if ( !isObject(left[key]) ) left[key] = {}; left[key] = merge( true, left[key], right[key] ); } else { left[key] = right[key]; } } } } return left; }; /** * Return the number of key/value pairs within an object * * @param {Object} obj The object to count * @return {Number} The number of pairs in the object */ (function(useCount) { Object.count = function count(obj) { if ( useCount ) return obj.__count__; return Object.keys(obj).length; }; })(({}).__count__ === 0); -/** - * Return an array containing the list of keys within the object - * - * @param {Object} obj The object to take keys from - * @return {Array} The array of keys - */ -if ( !Object.keys ) - Object.keys = function keys(obj) { - var keys = []; - for ( var k in obj ) - if ( obj.hasOwnProperty( k ) ) - keys.push( k ); - return keys; - }; - -/** - * Return an array containing the list of values within the object - * - * @param {Object} obj The object to take values from - * @return {Array} The array of values - */ -if ( !Object.values ) - Object.values = function values(obj) { - var values = []; - for ( var k in obj ) - if ( obj.hasOwnProperty( k ) ) - values.push( obj[k] ); - return values; - }; - diff --git a/src/String.js b/src/extras/String.js similarity index 96% rename from src/String.js rename to src/extras/String.js index ff7d035..7589af4 100644 --- a/src/String.js +++ b/src/extras/String.js @@ -1,355 +1,339 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; -/** - * Trim all whitespace from the left side of the string - * - * @return {String} The new trimmed string - */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; -/** - * Trim all whitespace from both sides of the string - * - * @return {String} The new trimmed string - */ -if ( !String.prototype.trim ) - String.prototype.trim = function trim() { - return this.trimLeft().trimRight(); - }; - - /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { chars = chars || ' '; var expand = Math.max(0, len - this.length); return chars.expand(Math.floor(expand/2)) + this + chars.expand(Math.ceil(expand/2)); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight(len, chars) { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this.toString(), '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this.toString() ]; }; /** * Split up a string by a separator. * This behaves the same as .split when used without a limit. The difference * between .split and .explode is that when used with a limit .split discards * anything over the limit, and .explode leaves them intact within the last string * * "foo,bar,baz".split(',', 2); // ["foo","bar"] * "foo,bar,baz".explode(',', 2); // ["foo", "bar,baz"] * @param {String} sep The separator to split by * @param {Number} [limit=Infinity] The split limit * @return {Array} The slitted array */ String.prototype.explode = function explode(sep, limit) { if ( !limit ) return this.split(sep); // Next version we will support RegExp. // Note that .split handles regex as if you always passed a /g to .match //if ( sep instanceof RegExp ) { // sep = RegExp.rebuildFrom(sep, { global: true }); //} else { var s = this.split(sep); var ss = s.splice(0, limit); if ( s.length ) { var sss = ss.pop(); ss.push([sss].concat(s).join(sep)); } return ss; //} }; /** * Search through a string starting at an offset and collect all the matches * to that regex into an array. * Using a normal regex this returns an array of strings * If the regex contains groups then instead it returns an array of arrays * containing the groups. * * @param {RegExp} regex Regular expression to scan over the string with * @param {Number} [offset=0] Offset to start at. * @return {Array} List of matches */ String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset += m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); }; diff --git a/src/Array16.js b/src/js16/Array.js similarity index 99% rename from src/Array16.js rename to src/js16/Array.js index edc4caf..b684394 100644 --- a/src/Array16.js +++ b/src/js16/Array.js @@ -1,217 +1,217 @@ /** - * @fileOverview This file contains Array compatibility prototypes for those introduced in JavaScript 1.6 + * @fileOverview This file contains Array compatibility prototypes for those introduced in JavaScript 1.6 and es5 */ /**#@+ * @native 1.6 */ /** * Returns the first index at which a given element can be found in the array, or -1 if it is not present. * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/indexOf * * @name indexOf * @methodOf Array.prototype * * @param elt Element to locate in the array * @param {Number} [from=0] The index at which to begin the search * @return {Number} The index of the first occurence of the element or -1 if not found */ if (!Array.prototype.indexOf) { Array.prototype.indexOf = function(elt /*, from*/) { var len = this.length >>> 0; var from = Number(arguments[1]) || 0; from = (from < 0) ? Math.ceil(from) : Math.floor(from); if (from < 0) from += len; for (; from < len; from++) { if (from in this && this[from] === elt) return from; } return -1; }; } /** * Returns the last index at which a given element can be found in the array, * or -1 if it is not present. The array is searched backwards, starting at fromIndex. * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/lastIndexOf * * @name lastIndexOf * @methodOf Array.prototype * * @param elt Element to locate in the array * @param {Number} [from=0] The index at which to begin the search * @return {Number} The index of the last occurence of the element or -1 if not found */ if (!Array.prototype.lastIndexOf) { Array.prototype.lastIndexOf = function(elt /*, from*/) { var len = this.length; var from = Number(arguments[1]); if (isNaN(from)) { from = len - 1; } else { from = (from < 0) ? Math.ceil(from) : Math.floor(from); if (from < 0) from += len; else if (from >= len) from = len - 1; } for (; from > -1; from--) { if (from in this && this[from] === elt) return from; } return -1; }; } /** * Tests whether all elements in the array pass the test implemented by the provided function. * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every * * @name every * @methodOf Array.prototype * * @param {Function} fun Function to test for each element * @param [thisp] Object to use as this when executing callback * @return {Boolean} Boolean indicating whether all elements in the array passed or not */ if (!Array.prototype.every) { Array.prototype.every = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this && !fun.call(thisp, this[i], i, this)) return false; } return true; }; } /** * Creates a new array with all elements that pass the test implemented by the provided function * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter * * @name filter * @methodOf Array.prototype * * @param {Function} fun Function to test each element of the array * @param [thisp] Object to use as this when executing callback * @return {Array} New array with all elements that passed */ if (!Array.prototype.filter) { Array.prototype.filter = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var res = new Array(); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this) { var val = this[i]; // in case fun mutates this if (fun.call(thisp, val, i, this)) res.push(val); } } return res; }; } /** * Executes a provided function once per array element * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach * * @name forEach * @methodOf Array.prototype * * @param {Function} fun Function to execute for each element * @param [thisp] Object to use as this when executing callback */ if (!Array.prototype.forEach) { Array.prototype.forEach = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this) fun.call(thisp, this[i], i, this); } }; } /** * Creates a new array with the results of calling a provided function on every element in this array * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map * * @name map * @methodOf Array.prototype * * @param {Function} fun Function that produces an element of the new Array from an element of the current one * @param [thisp] Object to use as this when executing callback * @return {Array} New array with the collected results */ if (!Array.prototype.map) { Array.prototype.map = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var res = new Array(len); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this) res[i] = fun.call(thisp, this[i], i, this); } return res; }; } /** * Tests whether some element in the array passes the test implemented by the provided function. * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some * * @name some * @methodOf Array.prototype * * @param {Function} fun Function to test for each element * @param [thisp] Object to use as this when executing callback * @return {Boolean} Boolean indicating whether some element in the array passed or not */ if (!Array.prototype.some) { Array.prototype.some = function(fun /*, thisp*/) { var i = 0, len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var thisp = arguments[1]; for (; i < len; i++) { if (i in this && fun.call(thisp, this[i], i, this)) return true; } return false; }; } /**#@-*/ diff --git a/src/Array18.js b/src/js18/Array.js similarity index 98% rename from src/Array18.js rename to src/js18/Array.js index ca9364e..c4737f8 100644 --- a/src/Array18.js +++ b/src/js18/Array.js @@ -1,108 +1,108 @@ /** - * @fileOverview This file contains Array compatibility prototypes for those introduced in JavaScript 1.8 + * @fileOverview This file contains Array compatibility prototypes for those introduced in JavaScript 1.8 and es5 */ /**#@+ * @native 1.8 */ /** * Apply a function against an accumulator and each value of the array (from left-to-right) as to reduce it to a single value. * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduce * * @name reduce * @methodOf Array.prototype * * @param {Function} fun Function to execute on each value in the array * @param [initial] Object to use as the first argument to the first call of the callback * @return The final value created by the reduce */ if (!Array.prototype.reduce) { Array.prototype.reduce = function(fun /*, initial*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); // no value to return if no initial value and an empty array if (len == 0 && arguments.length == 1) throw new TypeError(); var i = 0; if (arguments.length >= 2) { var rv = arguments[1]; } else { do { if (i in this) { rv = this[i++]; break; } // if array contains no values, no initial value to return if (++i >= len) throw new TypeError(); } while (true); } for (; i < len; i++) { if (i in this) rv = fun.call(null, rv, this[i], i, this); } return rv; }; } /** * Apply a function simultaneously against two values of the array (from right-to-left) as to reduce it to a single value. * * @see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduceRight * * @name reduceRight * @methodOf Array.prototype * * @param {Function} fun Function to execute on each value in the array * @param [initial] Object to use as the first argument to the first call of the callback * @return The final value created by the reduce */ if (!Array.prototype.reduceRight) { Array.prototype.reduceRight = function(fun /*, initial*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); // no value to return if no initial value, empty array if (len == 0 && arguments.length == 1) throw new TypeError(); var i = len - 1; if (arguments.length >= 2) { var rv = arguments[1]; } else { do { if (i in this) { rv = this[i--]; break; } // if array contains no values, no initial value to return if (--i < 0) throw new TypeError(); } while (true); } for (; i >= 0; i--) { if (i in this) rv = fun.call(null, rv, this[i], i, this); } return rv; }; } /**#@-*/
dantman/wrench
e8761fd98c153cbc6ac67765d06fa9e5293e36ec
Change the method of replacing the global. Date is already scoped so we can use a var'less set even in ES5 strict and we don't have to try to guess the global object.
diff --git a/src/isodate.js b/src/isodate.js index b164276..426bd0f 100644 --- a/src/isodate.js +++ b/src/isodate.js @@ -1,76 +1,71 @@ if ( isNaN(Date.parse("2000-01-01T00:00:00.000Z")) ) { // This embedding implementation does not handle ISO dates - (function(NativeDate, global) { + Date = (function(NativeDate) { var Date = function(arg) { if ( this instanceof Date || this instanceof NativeDate ) { var d = typeof arg === "string" ? // We explicitly pass it through parse: new NativeDate(Date.parse(arg)) : // We have to manually make calls depending on argument // length here arguments.length >= 7 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5], arguments[6]) : arguments.length >= 6 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5]) : arguments.length >= 5 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4]) : arguments.length >= 4 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3]) : arguments.length >= 3 ? new NativeDate(arguments[0], arguments[1], arguments[2]) : arguments.length >= 2 ? new NativeDate(arguments[0], arguments[1]) : arguments.length >= 1 ? new NativeDate(arguments[0]) : new NativeDate(); d.constructor = Date; // Prevent mixups with unfixed Date object return d; } return NativeDate.apply(this, arguments); } // Copy any custom methods a 3rd party library may have added for ( var key in NativeDate ) Date[key] = NativeDate[key]; // Copy "native" methods explicitly, they may be non-enumerable Date.now = NativeDate.now; Date.UTC = NativeDate.UTC; Date.prototype = NativeDate.prototype; // Upgrade Date.parse to handle the ISO dates we use // TODO review specification to ascertain whether it is // necessary to implement partial ISO date strings. Date.parse = function(string) { var m = /^(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d(?:\.\d+)?)Z$/.exec(string); if ( m ) { m.shift(); // kill the match string for ( var i = 0; i < m.length; i++ ) { // use parseFloat instead of parseInt so the milliseconds // don't get stripped // XXX consider separating the seconds and miliseconds // to avoid floating point precision error. m[i] = parseFloat(m[i], 10); // m[1] is the month. Months are 0-11 in JavaScript // Date objects, but 1-12 in ISO notation, so we // decrement. if ( i === 1 ) m[i]--; } if ( m.length > 5 ) { var floor = Math.floor(m[5]) // Because of floating point precision, in one of Dan // Friesen's tests, 27.677 is being turned into // 676.9999999999995 instead of 677 m[6] = Math.round((m[5] - floor) * 1000); m[5] = floor; } return NativeDate.UTC.apply(this, m); } return NativeDate.parse.apply(this, arguments); }; - global.Date = Date; - })( - Date, - this.Date === Date ? // this === global ? - this : undefined // XXX where is "global" if "this" !== "global" ? - // (Helma NG, GPSEE, possibly Flusspferd) - ); + return Date; + })(Date); }
dantman/wrench
ca0739fdf3ad3fc3e54aeb31a6ecb8b57979f6a6
Switch from isString to typeof test for date. We probably don't need the additional string object made to work.
diff --git a/src/isodate.js b/src/isodate.js index b8b0c87..b164276 100644 --- a/src/isodate.js +++ b/src/isodate.js @@ -1,76 +1,76 @@ if ( isNaN(Date.parse("2000-01-01T00:00:00.000Z")) ) { // This embedding implementation does not handle ISO dates (function(NativeDate, global) { var Date = function(arg) { if ( this instanceof Date || this instanceof NativeDate ) { - var d = isString(arg) ? + var d = typeof arg === "string" ? // We explicitly pass it through parse: new NativeDate(Date.parse(arg)) : // We have to manually make calls depending on argument // length here arguments.length >= 7 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5], arguments[6]) : arguments.length >= 6 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5]) : arguments.length >= 5 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4]) : arguments.length >= 4 ? new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3]) : arguments.length >= 3 ? new NativeDate(arguments[0], arguments[1], arguments[2]) : arguments.length >= 2 ? new NativeDate(arguments[0], arguments[1]) : arguments.length >= 1 ? new NativeDate(arguments[0]) : new NativeDate(); d.constructor = Date; // Prevent mixups with unfixed Date object return d; } return NativeDate.apply(this, arguments); } // Copy any custom methods a 3rd party library may have added for ( var key in NativeDate ) Date[key] = NativeDate[key]; // Copy "native" methods explicitly, they may be non-enumerable Date.now = NativeDate.now; Date.UTC = NativeDate.UTC; Date.prototype = NativeDate.prototype; // Upgrade Date.parse to handle the ISO dates we use // TODO review specification to ascertain whether it is // necessary to implement partial ISO date strings. Date.parse = function(string) { var m = /^(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d(?:\.\d+)?)Z$/.exec(string); if ( m ) { m.shift(); // kill the match string for ( var i = 0; i < m.length; i++ ) { // use parseFloat instead of parseInt so the milliseconds // don't get stripped // XXX consider separating the seconds and miliseconds // to avoid floating point precision error. m[i] = parseFloat(m[i], 10); // m[1] is the month. Months are 0-11 in JavaScript // Date objects, but 1-12 in ISO notation, so we // decrement. if ( i === 1 ) m[i]--; } if ( m.length > 5 ) { var floor = Math.floor(m[5]) // Because of floating point precision, in one of Dan // Friesen's tests, 27.677 is being turned into // 676.9999999999995 instead of 677 m[6] = Math.round((m[5] - floor) * 1000); m[5] = floor; } return NativeDate.UTC.apply(this, m); } return NativeDate.parse.apply(this, arguments); }; global.Date = Date; })( Date, this.Date === Date ? // this === global ? this : undefined // XXX where is "global" if "this" !== "global" ? // (Helma NG, GPSEE, possibly Flusspferd) ); }
dantman/wrench
e3b946df80329320c6e367e1c8a899fd9a7f421c
Restore large conditional kriskowal replaced with an .apply call. Using .apply does not work on standard classes.
diff --git a/src/isodate.js b/src/isodate.js index 812e2f2..b8b0c87 100644 --- a/src/isodate.js +++ b/src/isodate.js @@ -1,62 +1,76 @@ if ( isNaN(Date.parse("2000-01-01T00:00:00.000Z")) ) { // This embedding implementation does not handle ISO dates (function(NativeDate, global) { var Date = function(arg) { if ( this instanceof Date || this instanceof NativeDate ) { var d = isString(arg) ? // We explicitly pass it through parse: new NativeDate(Date.parse(arg)) : // We have to manually make calls depending on argument // length here - NativeDate.constructor.apply(new NativeDate(), arguments); + arguments.length >= 7 ? + new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5], arguments[6]) : + arguments.length >= 6 ? + new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5]) : + arguments.length >= 5 ? + new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4]) : + arguments.length >= 4 ? + new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3]) : + arguments.length >= 3 ? + new NativeDate(arguments[0], arguments[1], arguments[2]) : + arguments.length >= 2 ? + new NativeDate(arguments[0], arguments[1]) : + arguments.length >= 1 ? + new NativeDate(arguments[0]) : + new NativeDate(); d.constructor = Date; // Prevent mixups with unfixed Date object return d; } return NativeDate.apply(this, arguments); } // Copy any custom methods a 3rd party library may have added for ( var key in NativeDate ) Date[key] = NativeDate[key]; // Copy "native" methods explicitly, they may be non-enumerable Date.now = NativeDate.now; Date.UTC = NativeDate.UTC; Date.prototype = NativeDate.prototype; // Upgrade Date.parse to handle the ISO dates we use // TODO review specification to ascertain whether it is // necessary to implement partial ISO date strings. Date.parse = function(string) { var m = /^(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d(?:\.\d+)?)Z$/.exec(string); if ( m ) { m.shift(); // kill the match string for ( var i = 0; i < m.length; i++ ) { // use parseFloat instead of parseInt so the milliseconds // don't get stripped // XXX consider separating the seconds and miliseconds // to avoid floating point precision error. m[i] = parseFloat(m[i], 10); // m[1] is the month. Months are 0-11 in JavaScript // Date objects, but 1-12 in ISO notation, so we // decrement. if ( i === 1 ) m[i]--; } if ( m.length > 5 ) { var floor = Math.floor(m[5]) // Because of floating point precision, in one of Dan // Friesen's tests, 27.677 is being turned into // 676.9999999999995 instead of 677 m[6] = Math.round((m[5] - floor) * 1000); m[5] = floor; } return NativeDate.UTC.apply(this, m); } return NativeDate.parse.apply(this, arguments); }; global.Date = Date; })( Date, this.Date === Date ? // this === global ? this : undefined // XXX where is "global" if "this" !== "global" ? // (Helma NG, GPSEE, possibly Flusspferd) ); }
dantman/wrench
34b3bb79b22cb0804b1fcec08cfb65aa1a69ad1a
Use tabs not spaces.
diff --git a/src/isodate.js b/src/isodate.js index efa7653..812e2f2 100644 --- a/src/isodate.js +++ b/src/isodate.js @@ -1,62 +1,62 @@ if ( isNaN(Date.parse("2000-01-01T00:00:00.000Z")) ) { // This embedding implementation does not handle ISO dates (function(NativeDate, global) { var Date = function(arg) { if ( this instanceof Date || this instanceof NativeDate ) { var d = isString(arg) ? - // We explicitly pass it through parse: + // We explicitly pass it through parse: new NativeDate(Date.parse(arg)) : - // We have to manually make calls depending on argument - // length here - NativeDate.constructor.apply(new NativeDate(), arguments) + // We have to manually make calls depending on argument + // length here + NativeDate.constructor.apply(new NativeDate(), arguments); d.constructor = Date; // Prevent mixups with unfixed Date object return d; } return NativeDate.apply(this, arguments); } // Copy any custom methods a 3rd party library may have added for ( var key in NativeDate ) Date[key] = NativeDate[key]; // Copy "native" methods explicitly, they may be non-enumerable Date.now = NativeDate.now; Date.UTC = NativeDate.UTC; Date.prototype = NativeDate.prototype; - // Upgrade Date.parse to handle the ISO dates we use - // TODO review specification to ascertain whether it is - // necessary to implement partial ISO date strings. + // Upgrade Date.parse to handle the ISO dates we use + // TODO review specification to ascertain whether it is + // necessary to implement partial ISO date strings. Date.parse = function(string) { var m = /^(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d(?:\.\d+)?)Z$/.exec(string); if ( m ) { m.shift(); // kill the match string for ( var i = 0; i < m.length; i++ ) { - // use parseFloat instead of parseInt so the milliseconds - // don't get stripped - // XXX consider separating the seconds and miliseconds - // to avoid floating point precision error. + // use parseFloat instead of parseInt so the milliseconds + // don't get stripped + // XXX consider separating the seconds and miliseconds + // to avoid floating point precision error. m[i] = parseFloat(m[i], 10); - // m[1] is the month. Months are 0-11 in JavaScript - // Date objects, but 1-12 in ISO notation, so we - // decrement. + // m[1] is the month. Months are 0-11 in JavaScript + // Date objects, but 1-12 in ISO notation, so we + // decrement. if ( i === 1 ) m[i]--; } if ( m.length > 5 ) { var floor = Math.floor(m[5]) - // Because of floating point precision, in one of Dan - // Friesen's tests, 27.677 is being turned into - // 676.9999999999995 instead of 677 + // Because of floating point precision, in one of Dan + // Friesen's tests, 27.677 is being turned into + // 676.9999999999995 instead of 677 m[6] = Math.round((m[5] - floor) * 1000); m[5] = floor; } return NativeDate.UTC.apply(this, m); } return NativeDate.parse.apply(this, arguments); }; global.Date = Date; })( - Date, - this.Date === Date ? // this === global ? - this : undefined // XXX where is "global" if "this" !== "global" ? - // (Helma NG, GPSEE, possibly Flusspferd) - ); + Date, + this.Date === Date ? // this === global ? + this : undefined // XXX where is "global" if "this" !== "global" ? + // (Helma NG, GPSEE, possibly Flusspferd) + ); }
dantman/wrench
34ea0e863e787209ea47371103f37e9db9524dd7
Generalized for CommonJS, started a CommonJS test.
diff --git a/isodate.js b/isodate.js index 28cb8c7..efa7653 100644 --- a/isodate.js +++ b/isodate.js @@ -1,57 +1,62 @@ if ( isNaN(Date.parse("2000-01-01T00:00:00.000Z")) ) { - // This browser has not implemented parsing of ISO dates - (function(NativeDate) { + // This embedding implementation does not handle ISO dates + (function(NativeDate, global) { var Date = function(arg) { if ( this instanceof Date || this instanceof NativeDate ) { var d = isString(arg) ? - new NativeDate(Date.parse(arg)) : // We explicitly pass it through parse - // We have to manually make calls depending on argument length here - arguments.length >= 7 ? - new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5], arguments[6]) : - arguments.length >= 6 ? - new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4], arguments[5]) : - arguments.length >= 5 ? - new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3], arguments[4]) : - arguments.length >= 4 ? - new NativeDate(arguments[0], arguments[1], arguments[2], arguments[3]) : - arguments.length >= 3 ? - new NativeDate(arguments[0], arguments[1], arguments[2]) : - arguments.length >= 2 ? - new NativeDate(arguments[0], arguments[1]) : - arguments.length >= 1 ? - new NativeDate(arguments[0]) : - new NativeDate(); + // We explicitly pass it through parse: + new NativeDate(Date.parse(arg)) : + // We have to manually make calls depending on argument + // length here + NativeDate.constructor.apply(new NativeDate(), arguments) d.constructor = Date; // Prevent mixups with unfixed Date object return d; } return NativeDate.apply(this, arguments); } // Copy any custom methods a 3rd party library may have added for ( var key in NativeDate ) Date[key] = NativeDate[key]; - // Copy native methods explicitly, they may be non-enumerable + // Copy "native" methods explicitly, they may be non-enumerable Date.now = NativeDate.now; Date.UTC = NativeDate.UTC; Date.prototype = NativeDate.prototype; - // Upgrade Date.parse to handle the ISO dates we use (maybe we'll upgrade it more later and put it into Wrench.js) + // Upgrade Date.parse to handle the ISO dates we use + // TODO review specification to ascertain whether it is + // necessary to implement partial ISO date strings. Date.parse = function(string) { var m = /^(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d(?:\.\d+)?)Z$/.exec(string); if ( m ) { m.shift(); // kill the match string for ( var i = 0; i < m.length; i++ ) { - m[i] = parseFloat(m[i], 10); // use parseFloat instead of parseInt so the milliseconds don't get stripped - if ( i === 1 ) // This is the month, we need to decrement this + // use parseFloat instead of parseInt so the milliseconds + // don't get stripped + // XXX consider separating the seconds and miliseconds + // to avoid floating point precision error. + m[i] = parseFloat(m[i], 10); + // m[1] is the month. Months are 0-11 in JavaScript + // Date objects, but 1-12 in ISO notation, so we + // decrement. + if ( i === 1 ) m[i]--; } if ( m.length > 5 ) { var floor = Math.floor(m[5]) - m[6] = Math.round((m[5] - floor) * 1000); // For some reason in my test 27.677 is being turned into 676.9999999999995 instead of 677 + // Because of floating point precision, in one of Dan + // Friesen's tests, 27.677 is being turned into + // 676.9999999999995 instead of 677 + m[6] = Math.round((m[5] - floor) * 1000); m[5] = floor; } return NativeDate.UTC.apply(this, m); } return NativeDate.parse.apply(this, arguments); }; - window.Date = Date; - })(Date); + global.Date = Date; + })( + Date, + this.Date === Date ? // this === global ? + this : undefined // XXX where is "global" if "this" !== "global" ? + // (Helma NG, GPSEE, possibly Flusspferd) + ); } diff --git a/test.js b/test.js new file mode 100644 index 0000000..ee930cc --- /dev/null +++ b/test.js @@ -0,0 +1,16 @@ + +require("./isodate"); +var ASSERT = require("assert"); + +var $ERROR = function (messgae) { + ASSERT.ok(false, message); +} + +exports.testReflexiveParseFormat = function () { + var IsoDate = "2010-01-01T00:00:00.000Z"; + ASSERT.equal(IsoDate, new Date(Date.parse(IsoDate)).toISOString()); +}; + +if (require.main == module) + require("test").run(exports); +
dantman/wrench
150419966149bca257b8811d9f71b339cc04fa3b
Add tests to ensure toUnderscore and toDash don't break on round trips to toCamelCase.
diff --git a/test/tests/String.js b/test/tests/String.js index 5c66b13..6f52ee3 100644 --- a/test/tests/String.js +++ b/test/tests/String.js @@ -1,199 +1,201 @@ exports["string.repeat"] = function() { assert("".repeat(0) === ""); assert("".repeat(1) === ""); assert("".repeat(2) === ""); assert("foo".repeat(0) === "", "Does not return empty string on .repeat(0)"); assert("foo".repeat(1) === "foo", "Does not pass through on .repeat(1)"); assert("foo".repeat(2) === "foofoo", "Fails to repeat string"); assert("foo".repeat(5) === "foofoofoofoofoo", "Fails on repeats larger than 2"); // separator assert("foo".repeat(3, ',') === "foo,foo,foo", "Fails to handle separators"); assert("foo".repeat(0, ',') === "", "Does not return empty string on .repeat(0, separator);"); }; exports["string.expand"] = function() { assert("".expand(0) === ""); assert("foo".expand(3) === "foo", "Expanding to same length does not work."); assert("foo".expand(6) === "foofoo", "Fails to expand to double size"); assert("foo".expand(5) === "foofo", "Fails to expand to partial size"); assert("foo".expand(7) === "foofoof", "Fails to expand to past twice the size"); assert("foo".expand(0) === "", "Does not return empty string on .expand(0)"); assert("foo".expand(2) === "fo", "Fails to truncate string"); }; exports["string.toFirstUpperCase"] = function() { assert("asdf".toFirstUpperCase() === "Asdf"); assert("Asdf".toFirstUpperCase() === "Asdf", "Does not pass through ucfirst strings"); assert("aSdF".toFirstUpperCase() === "ASdF", "Mangles case"); }; exports["string.toFirstLowerCase"] = function() { assert("Asdf".toFirstLowerCase() === "asdf"); assert("asdf".toFirstLowerCase() === "asdf", "Does not pass through lcfirst strings"); assert("AsDf".toFirstLowerCase() === "asDf", "Mangles case"); }; exports["string.toTitleCase"] = function() { assert("Foo".toTitleCase() === "Foo", "Does not pass through proper strings"); assert("foo".toTitleCase() === "Foo"); assert("fOO".toTitleCase() === "FOO", "Mangles case"); assert("foo bar".toTitleCase() === "Foo Bar", "Fails on multiple words (likely missing /g)"); assert("foo-bar".toTitleCase() === "Foo-Bar", "Fails on dash"); assert("foo\t\nbar".toTitleCase() === "Foo\t\nBar", "Fails on non-space whitespace"); }; exports["string.startsWith"] = function() { assert("foobarbaz".startsWith("foo"), "Does not match proper comparisons"); assert.not("afoobarbaz".startsWith("foo"), "False positives"); assert.not("FOOBARBAZ".startsWith("foo"), "Not case-sensitive"); assert.not("bazbarfoo".startsWith("foo"), "Matches strings ending with"); assert("foo".startsWith("foo"), "Fails when comparing the same string"); }; exports["string.endsWith"] = function() { assert("foobarbaz".endsWith("baz"), "Does not match proper comparisons"); assert.not("foobarbaza".endsWith("baz"), "False positives"); assert.not("FOOBARBAZ".endsWith("baz"), "Not case-sensitive"); assert.not("bazbarfoo".endsWith("baz"), "Matches strings ending with"); assert("baz".endsWith("baz"), "Fails when comparing the same string"); }; exports["string.contains"] = function() { assert("foobarbaz".contains("bar"), "Does not match proper comparisons"); assert.not("foobarbaz".contains("me"), "False positives"); assert("foobarbaz".contains("baz"), "Fails on end of string match"); assert("foobarbaz".contains("foo"), "Fails on start of string match"); }; exports["string.numberOf"] = function() { assert("abcdabaz".numberOf("c") === 1); assert("abcdabaz".numberOf("e") === 0, "Fails on not-found"); assert("abcdabaz".numberOf("b") === 2, "Fails on more than 1"); assert("abcdabaz".numberOf("z") === 1, "Fails on end of string match"); assert("abcdabaz".numberOf("a") === 3, "Fails on start of string match"); }; exports["string.reverse"] = function() { assert(typeof "asdf".reverse() === 'string', "Does not return strings"); assert("asdf".reverse() === "fdsa", "Incorrect string reversal"); }; exports["string.trimLeft"] = function() { assert("asdf".trimLeft() === "asdf", "Mangles strings"); assert(" asdf".trimLeft() === "asdf", "Fails to trim"); assert(" asdf".trimLeft() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trimLeft() === "asdf ", "Trims off the right"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.trimRight"] = function() { assert("asdf".trimRight() === "asdf", "Mangles strings"); assert("asdf ".trimRight() === "asdf", "Fails to trim"); assert("asdf ".trimRight() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trimRight() === " asdf", "Trims off the left"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.trim"] = function() { assert("asdf".trim() === "asdf", "Mangles strings"); assert(" asdf".trim() === "asdf", "Fails to trim"); assert("asdf ".trim() === "asdf", "Fails to trim"); assert(" asdf".trim() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trim() === "asdf", "Fails to trim both sides properly"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.strip"] = function() { assert("__asdfqwerty__".strip("_") === "asdfqwerty"); }; exports["string.stripLeft"] = function() { assert("__asdfqwerty__".stripLeft("_") === "asdfqwerty__"); }; exports["string.stripRight"] = function() { assert("__asdfqwerty__".stripRight("_") === "__asdfqwerty"); }; exports["string.pad"] = function() { assert("asdf".pad(2) === "asdf", "Mangles padding strings larger than pad length"); assert("asdf".pad(10) === " asdf "); assert("asdf".pad(10, "@") === "@@@asdf@@@", "Fails with character list"); assert("asdf".pad(8, "@!") === "@!asdf@!", "Fails with multi-character list"); assert("asdf".pad(7, "@!") === "@asdf@!", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.padLeft"] = function() { assert("asdf".padLeft(2) === "asdf", "Mangles padding strings larger than pad length"); assert("asdf".padLeft(10) === " asdf"); assert("asdf".padLeft(10, "@") === "@@@@@@asdf", "Fails with character list"); assert("asdf".padLeft(10, "@!") === "@!@!@!asdf", "Fails with multi-character list"); assert("asdf".padLeft(7, "@!") === "@!@asdf", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.padRight"] = function() { assert("asdf".padRight(2) === "asdf", "Mangles padding strings larger than pad length"); assert("asdf".padRight(10) === "asdf "); assert("asdf".padRight(10, "@") === "asdf@@@@@@", "Fails with character list"); assert("asdf".padRight(10, "@!") === "asdf@!@!@!", "Fails with multi-character list"); assert("asdf".padRight(7, "@!") === "asdf@!@", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.partition"] = function() { assert.match("foo=bar=baz".partition("="), ["foo", "=", "bar=baz"], "Fails on partition"); assert.match("foo-bar-baz".partition("="), ["foo-bar-baz", "", ""], "Fails on no partition"); }; exports["string.partitionRight"] = function() { assert.match("foo=bar=baz".partitionRight("="), ["foo=bar", "=", "baz"], "Fails on partition"); assert.match("foo-bar-baz".partitionRight("="), ["", "", "foo-bar-baz"], "Fails on no partition"); }; exports["string.explode"] = function() { var str = "foo,bar,baz"; assert.match(str.explode(','), str.split(','), "Explode with no limit does not give same output as .split"); assert.match(str.explode(',', 2), ["foo","bar,baz"], "Fails with limit"); assert.match(str.explode(',', 3), ["foo","bar", "baz"], "Fails with even limit"); assert.match(str.explode(',', 4), ["foo","bar", "baz"], "Fails with limit over the number of items"); //var str = ".asdf.asdf.asdf"; //assert.match(str.explode(/./), ["", "asdf", "asdf", "asdf"], "Fails on regex"); //assert.match(str.explode(/^./g), ["", "asdf.asdf.asdf"], "Fails on /g regex using ^"); //assert.match(str.explode(/^./), ["", "asdf.asdf.asdf"], "Fails on non-/g regex using ^"); }; exports["string.scan"] = function() { assert.match("foo bar baz".scan(/\w+/), ["foo","bar","baz"]); assert.match("foo bar baz".scan(/\w+/, 4), ["bar","baz"], "Fails on offset"); var s = "foo1 bar2 baz3".scan(/(\w+)(\d)/); assert.match(s[0], ["foo","1"], "Fails on groups"); assert.match(s[1], ["bar","2"], "Fails on groups"); assert.match(s[2], ["baz","3"], "Fails on groups"); assert("foo bar baz".scan(/(\w+)/)[0], ["foo"], "Fails on single group"); assert("foo bar baz".scan(/(\w+)/g)[0], ["foo"], "Fails on offset using groups"); }; exports["string.toCamelCase"] = function() { assert("camelCase".toCamelCase() === "camelCase", "Does not pass through existing camelCase strings"); assert("TitleCase".toCamelCase() === "TitleCase", "Mangles TitleCase strings"); assert("dash-string".toCamelCase() === "dashString", "Fails on dash-strings"); assert("dash-string-extend".toCamelCase() === "dashStringExtend", "Fails with more than one dash (missing /g likely)"); assert("-dash-string".toCamelCase() === "DashString", "Fails with - prefixed dash-strings"); assert("underscore_string".toCamelCase() === "underscoreString", "Fails on undescore_strings"); assert("-mixed_set-asdfString".toCamelCase() === "MixedSetAsdfString", "Fails on mixed"); }; exports["string.toUnderscore"] = function() { assert("underscore_string".toUnderscore() === "underscore_string", "Does not pass through existing undescore_strings"); assert("camelCase".toUnderscore() === "camel_case", "Failes on camelCase"); assert("camelCaseExtend".toUnderscore() === "camel_case_extend", "Fails with more than one hump (missing /g likely)"); assert("TitleCase".toUnderscore() === "_title_case", "Failes on TitleCase"); + assert("_underscore_string".toCamelCase().toUnderscore() === "_underscore_string", "Breaks on round trip to camelCase."); }; exports["string.toDash"] = function() { assert("dash-string".toDash() === "dash-string", "Does not pass through existing dash-strings"); assert("camelCase".toDash() === "camel-case", "Failes on camelCase"); assert("camelCaseExtend".toDash() === "camel-case-extend", "Fails with more than one hump (missing /g likely)"); assert("TitleCase".toDash() === "-title-case", "Failes on TitleCase"); + assert("-dash-string".toCamelCase().toDash() === "-dash-string", "Breaks on round trip to camelCase."); };
dantman/wrench
7173de2e8b51bc87b15ccc9d96d8cdd9f9756559
Add new fn.newApply function that lets you combine new Fn constructing with a variable list of arguments as if you used .apply +Increment version to alpha
diff --git a/Makefile b/Makefile index 26fb669..79f9199 100644 --- a/Makefile +++ b/Makefile @@ -1,142 +1,143 @@ SRC_DIR = ./src BUILD_DIR = ./build DOC_DIR = ./doc DIST_DIR = ./dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ + ${SRC_DIR}/Function.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/String.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar TAR_NAME = wrench-${WRENCH_VER}.tar.gz ZIP_NAME = wrench-${WRENCH_VER}.zip all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ test15: all cd test; java -jar ../build/js.jar test15.js test17: all cd test; java -jar ../build/js.jar -version 170 test17.js # Distribution ${DIST_DIR}/build: ${DIST_DIR} -@@mkdir ${DIST_DIR}/build ${DIST_DIR}/src: ${DIST_DIR} -@@mkdir ${DIST_DIR}/src ${DIST_DIR}/src/*: ${DIST_DIR}/src ${SRC_DIR}/* @@cp ${SRC_DIR}/* ${DIST_DIR}/src/ ${DIST_DIR}/build/js.jar: ${DIST_DIR}/build ${BUILD_DIR}/js.jar @@cp ${BUILD_DIR}/js.jar ${DIST_DIR}/build/ ${DIST_DIR}/build/yuicompressor-2.4.2.jar: ${DIST_DIR}/build ${BUILD_DIR}/yuicompressor-2.4.2.jar @@cp ${BUILD_DIR}/yuicompressor-2.4.2.jar ${DIST_DIR}/build/ ${DIST_DIR}/Makefile: ./Makefile @@cp ./Makefile ${DIST_DIR} ${DIST_DIR}/README: ./README @@cp ./README ${DIST_DIR} ${DIST_DIR}/version.txt: ./version.txt @@cp ./version.txt ${DIST_DIR} ${DIST_DIR}/test: ./test ./test/* ./test/tests/* @@cp -r ./test ${DIST_DIR} ${DIST_DIR}/doc: docs @@cp -r ${DOC_DIR} ${DIST_DIR} # Note: doc/ is not yet ready for packaging. It uses absolute references to monkeyscript.org for some static components. build-dist: all ${DIST_DIR}/src/* ${DIST_DIR}/build/js.jar ${DIST_DIR}/build/yuicompressor-2.4.2.jar ${DIST_DIR}/Makefile ${DIST_DIR}/README ${DIST_DIR}/version.txt ${DIST_DIR}/test ${DIST_DIR}/doc @@cd ${DIST_DIR}; tar -czf ${TAR_NAME} --exclude=${TAR_NAME} --exclude=${ZIP_NAME} * @@cd ${DIST_DIR}; zip -rqn ".jar" ${ZIP_NAME} . -x ${TAR_NAME} -x ${ZIP_NAME} @@- mv "${DIST_DIR}/wrench15.js" "${DIST_DIR}/wrench15-${WRENCH_VER}.js" @@- mv "${DIST_DIR}/wrench15.min.js" "${DIST_DIR}/wrench15-${WRENCH_VER}.min.js" @@- mv "${DIST_DIR}/wrench17.js" "${DIST_DIR}/wrench17-${WRENCH_VER}.js" @@- mv "${DIST_DIR}/wrench18.js" "${DIST_DIR}/wrench18-${WRENCH_VER}.js" @@echo "Wrench distribution build complete." diff --git a/src/Function.js b/src/Function.js new file mode 100644 index 0000000..3ca1be8 --- /dev/null +++ b/src/Function.js @@ -0,0 +1,20 @@ +(function() { + var F = function() {}; + Function.prototype.newApply = function newApply(args) { + if ( this === Object || this === Boolean || this === String || this === Number ) { + if ( args.length === 0 ) { + return new this(); + } else { + return new this(args[0]); + } + } else { + F.prototype = this.prototype; + var thisp = new F(); + var returned = this.apply(thisp, args); + if ( returned !== undefined ) + thisp = returned; + return thisp; + } + }; +})(); + diff --git a/version.txt b/version.txt index 3eefcb9..69bbb3f 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -1.0.0 +1.0.1a
dantman/wrench
1a2cc5eb8b5640cbd94939b9dc9b21e1a78dcfcb
Mark 1.0.0 release.
diff --git a/version.txt b/version.txt index be12806..3eefcb9 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.1a +1.0.0
dantman/wrench
43318c4a7a757259669e61bcc8796f20d64f8c65
Have build-dist move .js files to versioned names.
diff --git a/Makefile b/Makefile index f94e151..26fb669 100644 --- a/Makefile +++ b/Makefile @@ -1,138 +1,142 @@ SRC_DIR = ./src BUILD_DIR = ./build DOC_DIR = ./doc DIST_DIR = ./dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/String.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar TAR_NAME = wrench-${WRENCH_VER}.tar.gz ZIP_NAME = wrench-${WRENCH_VER}.zip all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ test15: all cd test; java -jar ../build/js.jar test15.js test17: all cd test; java -jar ../build/js.jar -version 170 test17.js # Distribution ${DIST_DIR}/build: ${DIST_DIR} -@@mkdir ${DIST_DIR}/build ${DIST_DIR}/src: ${DIST_DIR} -@@mkdir ${DIST_DIR}/src ${DIST_DIR}/src/*: ${DIST_DIR}/src ${SRC_DIR}/* @@cp ${SRC_DIR}/* ${DIST_DIR}/src/ ${DIST_DIR}/build/js.jar: ${DIST_DIR}/build ${BUILD_DIR}/js.jar @@cp ${BUILD_DIR}/js.jar ${DIST_DIR}/build/ ${DIST_DIR}/build/yuicompressor-2.4.2.jar: ${DIST_DIR}/build ${BUILD_DIR}/yuicompressor-2.4.2.jar @@cp ${BUILD_DIR}/yuicompressor-2.4.2.jar ${DIST_DIR}/build/ ${DIST_DIR}/Makefile: ./Makefile @@cp ./Makefile ${DIST_DIR} ${DIST_DIR}/README: ./README @@cp ./README ${DIST_DIR} ${DIST_DIR}/version.txt: ./version.txt @@cp ./version.txt ${DIST_DIR} ${DIST_DIR}/test: ./test ./test/* ./test/tests/* @@cp -r ./test ${DIST_DIR} ${DIST_DIR}/doc: docs @@cp -r ${DOC_DIR} ${DIST_DIR} # Note: doc/ is not yet ready for packaging. It uses absolute references to monkeyscript.org for some static components. build-dist: all ${DIST_DIR}/src/* ${DIST_DIR}/build/js.jar ${DIST_DIR}/build/yuicompressor-2.4.2.jar ${DIST_DIR}/Makefile ${DIST_DIR}/README ${DIST_DIR}/version.txt ${DIST_DIR}/test ${DIST_DIR}/doc @@cd ${DIST_DIR}; tar -czf ${TAR_NAME} --exclude=${TAR_NAME} --exclude=${ZIP_NAME} * @@cd ${DIST_DIR}; zip -rqn ".jar" ${ZIP_NAME} . -x ${TAR_NAME} -x ${ZIP_NAME} + @@- mv "${DIST_DIR}/wrench15.js" "${DIST_DIR}/wrench15-${WRENCH_VER}.js" + @@- mv "${DIST_DIR}/wrench15.min.js" "${DIST_DIR}/wrench15-${WRENCH_VER}.min.js" + @@- mv "${DIST_DIR}/wrench17.js" "${DIST_DIR}/wrench17-${WRENCH_VER}.js" + @@- mv "${DIST_DIR}/wrench18.js" "${DIST_DIR}/wrench18-${WRENCH_VER}.js" @@echo "Wrench distribution build complete."
dantman/wrench
5ba0d99240802c78d4e52bb132a0872ea69e923b
Cleanup some documentation comments.
diff --git a/src/Array.js b/src/Array.js index e4355c5..179688d 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,163 +1,163 @@ /** * @fileOverview This file contains new methods for the Array class */ /** * @name Array * @class A built-in class for expressing ordered lists of values. */ /** * Create a new array of a specified length filled with a certain value * * @constructs * @param {Number} size The size of the array to create * @param [value=undefined] The value to populate all the items in the array with */ Array.fill = function fill(size, value) { var arr = new Array(Number(size||0)); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = value; return arr; }; /** * Return a new array with the contents of this array repeated over * `num` amount of times. * * @param {Number} num The number of times to repeat the array * @return {Array} The new repeated array */ Array.prototype.repeat = function repeat(num) { return Array.prototype.concat.apply([], Array.fill(num, this)); }; /** * Check if the array contains an item * * @param {Number} item The item to look for * @return {Boolean} Whether or not the item was found within the array */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return {Array} A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return {Array} The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. * * @param {Number} i The index to return the item from */ Array.prototype.item = function item(i) { return this[i]; }; /** * Remove the first (or more) occurrence(s) of an item from the array * * @param item The item to remove * @param {Number} [max=1] The max number of items to remove, use Infinity to remove them all */ Array.prototype.remove = function remove(item, max) { if ( max === 0 ) return; if ( max === -1 ) max = Infinity; max = max || 1; while(max) { var i = this.indexOf(item); if( i < 0 ) break; this.splice(i, 1); max--; } // ToDo: Determine a reasonable return value }; /** * Append a list of items from an array onto the end of this array * * @param items Array The array of items to append to this array */ Array.prototype.append = function append(items) { return Array.prototype.push.apply( this, items ); }; /** * Clear an array of all items */ Array.prototype.clear = function clear() { return this.splice(0, this.length); }; /** * Return a new array clean of all undefined and null values inside of an array * if false is passed to empty then only undefined items are cleaned * if true is passed to empty then empty strings will also be cleaned * * @param {Boolean} [empty=undefined] Whether to also clean out empty strings or to not clear out nulls * @return {Array} The new array */ Array.prototype.clean = function clean(empty) { return this.filter(function(item) { if ( item === undefined ) return false; if ( empty !== false && item === null ) return false; if ( empty === true && item === "" ) return false; return true; }); }; /** * Return a random item from this array. * * @return A random item from the array */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; /** * A version of array.reduce() which only passes the two values to reduce on * to the callback so you can use native methods like Math.max inside a reduce. * - * @param Function fn The callback function + * @param {Function} fn The callback function */ Array.prototype.reduceNative = function reduceNative(fn) { return this.reduce(function(a, b) { return fn(a, b); }); }; /** * Returns a new version of this array which has been flattened * Flattening turns an array like [[1,2,3], [4,5,6], [7,8,9]]; * into one like [1,2,3,4,5,6,7,8,9]; * * @return {Array} The new flattened array */ Array.prototype.flat = function flat() { var arr = []; function reduce(item) { if( item instanceof Array ) item.forEach(reduce); else arr.push(item); }; this.forEach(reduce); return arr; }; diff --git a/src/Object.js b/src/Object.js index cc17b0b..ad4066f 100644 --- a/src/Object.js +++ b/src/Object.js @@ -1,101 +1,102 @@ /** * @fileOverview This file contains new methods for the Object class */ /** * @name Object * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. */ /** * Returns a new object with the passed object's keys as the new object's values * and the passed object's values as the keys to those values. * * @param {Object} obj The object to create an inverted object from * @return {Object} The inverted object */ Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; /** * Merges multiple objects together into the first object with a right dominant pattern. * This will modify the first object and override methods with the rightmost value. * * This method returns the object that was modified, so if you would like a new * object instead of one of your objects being overwritten use `Object.merge({}, ...);` * * @param {Boolean} [deep=false] Use a deep object merge - * @param {Object} ... Objects to merge + * @param {Object} obj Object to merge into + * @param {Object} ...objs Objects to merge into obj * @return {Object} The first object passed to merge */ Object.merge = function merge() { var a = Array.slice(arguments), left, deep = false; if ( typeof a[0] === 'boolean' ) deep = a.shift(); left = a.shift(); if ( left === null || typeof left !== 'object' ) throw new TypeError(); for ( var i = 0, l = a.length; i<l; i++ ) { var right = a[i]; for ( var key in right ) { if ( right.hasOwnProperty(key) ) { if ( deep && isObject(right[key]) ) { if ( !isObject(left[key]) ) left[key] = {}; left[key] = merge( true, left[key], right[key] ); } else { left[key] = right[key]; } } } } return left; }; /** * Return the number of key/value pairs within an object * * @param {Object} obj The object to count * @return {Number} The number of pairs in the object */ (function(useCount) { Object.count = function count(obj) { if ( useCount ) return obj.__count__; return Object.keys(obj).length; }; })(({}).__count__ === 0); /** * Return an array containing the list of keys within the object * * @param {Object} obj The object to take keys from * @return {Array} The array of keys */ if ( !Object.keys ) Object.keys = function keys(obj) { var keys = []; for ( var k in obj ) if ( obj.hasOwnProperty( k ) ) keys.push( k ); return keys; }; /** * Return an array containing the list of values within the object * * @param {Object} obj The object to take values from * @return {Array} The array of values */ if ( !Object.values ) Object.values = function values(obj) { var values = []; for ( var k in obj ) if ( obj.hasOwnProperty( k ) ) values.push( obj[k] ); return values; };
dantman/wrench
aea06861c062d2b77d2de212620f1bd58ad0d6e7
Only set Object.keys and Object.values if they are not already defined (these are ES5 methods)
diff --git a/src/Object.js b/src/Object.js index 360d9b4..cc17b0b 100644 --- a/src/Object.js +++ b/src/Object.js @@ -1,99 +1,101 @@ /** * @fileOverview This file contains new methods for the Object class */ /** * @name Object * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. */ /** * Returns a new object with the passed object's keys as the new object's values * and the passed object's values as the keys to those values. * * @param {Object} obj The object to create an inverted object from * @return {Object} The inverted object */ Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; /** * Merges multiple objects together into the first object with a right dominant pattern. * This will modify the first object and override methods with the rightmost value. * * This method returns the object that was modified, so if you would like a new * object instead of one of your objects being overwritten use `Object.merge({}, ...);` * * @param {Boolean} [deep=false] Use a deep object merge * @param {Object} ... Objects to merge * @return {Object} The first object passed to merge */ Object.merge = function merge() { var a = Array.slice(arguments), left, deep = false; if ( typeof a[0] === 'boolean' ) deep = a.shift(); left = a.shift(); if ( left === null || typeof left !== 'object' ) throw new TypeError(); for ( var i = 0, l = a.length; i<l; i++ ) { var right = a[i]; for ( var key in right ) { if ( right.hasOwnProperty(key) ) { if ( deep && isObject(right[key]) ) { if ( !isObject(left[key]) ) left[key] = {}; left[key] = merge( true, left[key], right[key] ); } else { left[key] = right[key]; } } } } return left; }; /** * Return the number of key/value pairs within an object * * @param {Object} obj The object to count * @return {Number} The number of pairs in the object */ (function(useCount) { Object.count = function count(obj) { if ( useCount ) return obj.__count__; return Object.keys(obj).length; }; })(({}).__count__ === 0); /** * Return an array containing the list of keys within the object * * @param {Object} obj The object to take keys from * @return {Array} The array of keys */ -Object.keys = function keys(obj) { - var keys = []; - for ( var k in obj ) - if ( obj.hasOwnProperty( k ) ) - keys.push( k ); - return keys; -}; +if ( !Object.keys ) + Object.keys = function keys(obj) { + var keys = []; + for ( var k in obj ) + if ( obj.hasOwnProperty( k ) ) + keys.push( k ); + return keys; + }; /** * Return an array containing the list of values within the object * * @param {Object} obj The object to take values from * @return {Array} The array of values */ -Object.values = function values(obj) { - var values = []; - for ( var k in obj ) - if ( obj.hasOwnProperty( k ) ) - values.push( obj[k] ); - return values; -}; +if ( !Object.values ) + Object.values = function values(obj) { + var values = []; + for ( var k in obj ) + if ( obj.hasOwnProperty( k ) ) + values.push( obj[k] ); + return values; + };
dantman/wrench
8e1ce29b3a80a105f92ddaad8cc4b538d27ddbb4
Fix broken object tests
diff --git a/test/tests/Object.js b/test/tests/Object.js index 2a099bf..d913169 100644 --- a/test/tests/Object.js +++ b/test/tests/Object.js @@ -1,84 +1,84 @@ exports["Object.invert inverts objects"] = function() { var object = { "foo": "bar", "baz": "splat" }; var inverted = Object.invert(object); assert(object !== inverted, "Object was mutated rather than cloned"); assert.not(inverted.foo === "bar", "Object may not have been inverted, foo key is still set to bar"); assert.not("foo" in inverted, "Object may not have been inverted, foo key still exists"); assert("bar" in inverted, "Inverted object is missing the bar key"); assert("splat" in inverted, "Inverted object is missing the splat key but not the bar key"); function F() {} F.prototype = { "badkey": "badvalue" } var object2 = new F; object2.foo = "bar"; var inverted2 = Object.invert(object2); assert.not("badvalue" in inverted2, "Inverted objects are taking keys from up the prototype chain"); }; exports["Object.merge merges objects"] = function() { var o = {}; assert(Object.merge(o, {}) === o, "Does not return the first object"); var arr = [], o2 = {}; Object.merge(o, { foo: 4, bar: arr, baz: o2 }); assert(o.foo === 4, "Does not merge values"); assert(o.bar === arr, "Copies arrays"); assert(o.baz === o2, "Copies objects in non-deep mode"); Object.merge(o, { foo: 5 }); assert(o.foo === 5, "Does not override existing keys"); Object.merge(o, { foo: 6 }, { foo: 7 }); assert(o.foo === 7, "Does not have right dominance"); var arr2 = [], o3 = {}; Object.merge(o, { bar: arr2, baz: o3 }); assert(o.bar !== arr, "Does not override arrays in non-deep"); assert(o.baz !== o2, "Does not override objects in non-deep"); Object.merge(true, o, { baz: { foo: 3 } }); - assert(o.baz !== o3 && o.baz.foo === 3, "Does not recursively merge in deep mode"); + assert(/*o.baz !== o3 &&*/ o.baz.foo === 3, "Does not recursively merge in deep mode"); Object.merge(true, o, { baz: { foo: 5 } }); assert(o.baz.foo === 5, "Does not override deeply"); var zoo = { foo: 5 }; Object.merge(true, o, { zoo: zoo }); assert(o.zoo && o.zoo.foo === 5, "Does not handle deep clone when no object exists in place"); assert(o.zoo !== zoo, "Copies objects to non-existant keys instead of cloning them"); Object.merge(true, o, { bar: ["foo"] }); - assert(o.bar.length === 0, "Mangles arrays trying to merge them when it shouldn't"); + assert.not(o.bar.length === 0, "Mangles arrays trying to merge them when it shouldn't"); var now = new Date; Object.merge(true, o, { date: now }); assert(o.date === now, "Mangles object instances like date by trying to copy them when it shouldn't"); }; exports["Object.count returns number of keys in object"] = function() { assert(Object.count({a:1,b:2}) === 2); assert(Object.count({}) === 0, "Fails on empty object"); function Foo() {} var f = new Foo(); f.a = 1; f.b = 2; assert(Object.count(f) === 2, "Fails on non-literal objects"); Foo.prototype.z = 3; assert(Object.count(f) === 2, "Polluted by prototypes"); }; exports["Object.keys returns array of keys in object"] = function() { assert.matchOne(Object.keys({a:1,b:2}), [["a", "b"], /*or*/ ["b", "a"]]); assert(Object.keys({}).length === 0, "Fails on empty object"); function Foo() {} var f = new Foo(); f.a = 1; f.b = 2; assert(Object.keys(f).length === 2, "Fails on non-literal objects"); Foo.prototype.z = 3; assert(Object.keys(f).length === 2, "Polluted by prototypes"); }; exports["Object.values returns array of values in object"] = function() { assert.matchOne(Object.values({a:1,b:2}), [[1, 2], /*or*/ [2, 1]]); assert(Object.values({}).length === 0, "Fails on empty object"); function Foo() {} var f = new Foo(); f.a = 1; f.b = 2; assert(Object.values(f).length === 2, "Fails on non-literal objects"); Foo.prototype.z = 3; assert(Object.values(f).length === 2, "Polluted by prototypes"); };
dantman/wrench
bda7cd3d0528179837c8784d6f61e1a8fdff7fb3
Implement .explode with String-only separator and expand tests.
diff --git a/src/String.js b/src/String.js index b0552c3..ff7d035 100644 --- a/src/String.js +++ b/src/String.js @@ -1,329 +1,355 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { chars = chars || ' '; var expand = Math.max(0, len - this.length); return chars.expand(Math.floor(expand/2)) + this + chars.expand(Math.ceil(expand/2)); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight(len, chars) { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this.toString(), '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this.toString() ]; }; +/** + * Split up a string by a separator. + * This behaves the same as .split when used without a limit. The difference + * between .split and .explode is that when used with a limit .split discards + * anything over the limit, and .explode leaves them intact within the last string + * + * "foo,bar,baz".split(',', 2); // ["foo","bar"] + * "foo,bar,baz".explode(',', 2); // ["foo", "bar,baz"] + * @param {String} sep The separator to split by + * @param {Number} [limit=Infinity] The split limit + * @return {Array} The slitted array + */ String.prototype.explode = function explode(sep, limit) { - + if ( !limit ) + return this.split(sep); + // Next version we will support RegExp. + // Note that .split handles regex as if you always passed a /g to .match + //if ( sep instanceof RegExp ) { + // sep = RegExp.rebuildFrom(sep, { global: true }); + //} else { + var s = this.split(sep); + var ss = s.splice(0, limit); + if ( s.length ) { + var sss = ss.pop(); + ss.push([sss].concat(s).join(sep)); + } + return ss; + //} }; /** * Search through a string starting at an offset and collect all the matches * to that regex into an array. * Using a normal regex this returns an array of strings * If the regex contains groups then instead it returns an array of arrays * containing the groups. * * @param {RegExp} regex Regular expression to scan over the string with * @param {Number} [offset=0] Offset to start at. * @return {Array} List of matches */ String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset += m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); }; diff --git a/test/tests/String.js b/test/tests/String.js index 035210d..5c66b13 100644 --- a/test/tests/String.js +++ b/test/tests/String.js @@ -1,193 +1,199 @@ exports["string.repeat"] = function() { assert("".repeat(0) === ""); assert("".repeat(1) === ""); assert("".repeat(2) === ""); assert("foo".repeat(0) === "", "Does not return empty string on .repeat(0)"); assert("foo".repeat(1) === "foo", "Does not pass through on .repeat(1)"); assert("foo".repeat(2) === "foofoo", "Fails to repeat string"); assert("foo".repeat(5) === "foofoofoofoofoo", "Fails on repeats larger than 2"); // separator assert("foo".repeat(3, ',') === "foo,foo,foo", "Fails to handle separators"); assert("foo".repeat(0, ',') === "", "Does not return empty string on .repeat(0, separator);"); }; exports["string.expand"] = function() { assert("".expand(0) === ""); assert("foo".expand(3) === "foo", "Expanding to same length does not work."); assert("foo".expand(6) === "foofoo", "Fails to expand to double size"); assert("foo".expand(5) === "foofo", "Fails to expand to partial size"); assert("foo".expand(7) === "foofoof", "Fails to expand to past twice the size"); assert("foo".expand(0) === "", "Does not return empty string on .expand(0)"); assert("foo".expand(2) === "fo", "Fails to truncate string"); }; exports["string.toFirstUpperCase"] = function() { assert("asdf".toFirstUpperCase() === "Asdf"); assert("Asdf".toFirstUpperCase() === "Asdf", "Does not pass through ucfirst strings"); assert("aSdF".toFirstUpperCase() === "ASdF", "Mangles case"); }; exports["string.toFirstLowerCase"] = function() { assert("Asdf".toFirstLowerCase() === "asdf"); assert("asdf".toFirstLowerCase() === "asdf", "Does not pass through lcfirst strings"); assert("AsDf".toFirstLowerCase() === "asDf", "Mangles case"); }; exports["string.toTitleCase"] = function() { assert("Foo".toTitleCase() === "Foo", "Does not pass through proper strings"); assert("foo".toTitleCase() === "Foo"); assert("fOO".toTitleCase() === "FOO", "Mangles case"); assert("foo bar".toTitleCase() === "Foo Bar", "Fails on multiple words (likely missing /g)"); assert("foo-bar".toTitleCase() === "Foo-Bar", "Fails on dash"); assert("foo\t\nbar".toTitleCase() === "Foo\t\nBar", "Fails on non-space whitespace"); }; exports["string.startsWith"] = function() { assert("foobarbaz".startsWith("foo"), "Does not match proper comparisons"); assert.not("afoobarbaz".startsWith("foo"), "False positives"); assert.not("FOOBARBAZ".startsWith("foo"), "Not case-sensitive"); assert.not("bazbarfoo".startsWith("foo"), "Matches strings ending with"); assert("foo".startsWith("foo"), "Fails when comparing the same string"); }; exports["string.endsWith"] = function() { assert("foobarbaz".endsWith("baz"), "Does not match proper comparisons"); assert.not("foobarbaza".endsWith("baz"), "False positives"); assert.not("FOOBARBAZ".endsWith("baz"), "Not case-sensitive"); assert.not("bazbarfoo".endsWith("baz"), "Matches strings ending with"); assert("baz".endsWith("baz"), "Fails when comparing the same string"); }; exports["string.contains"] = function() { assert("foobarbaz".contains("bar"), "Does not match proper comparisons"); assert.not("foobarbaz".contains("me"), "False positives"); assert("foobarbaz".contains("baz"), "Fails on end of string match"); assert("foobarbaz".contains("foo"), "Fails on start of string match"); }; exports["string.numberOf"] = function() { assert("abcdabaz".numberOf("c") === 1); assert("abcdabaz".numberOf("e") === 0, "Fails on not-found"); assert("abcdabaz".numberOf("b") === 2, "Fails on more than 1"); assert("abcdabaz".numberOf("z") === 1, "Fails on end of string match"); assert("abcdabaz".numberOf("a") === 3, "Fails on start of string match"); }; exports["string.reverse"] = function() { assert(typeof "asdf".reverse() === 'string', "Does not return strings"); assert("asdf".reverse() === "fdsa", "Incorrect string reversal"); }; exports["string.trimLeft"] = function() { assert("asdf".trimLeft() === "asdf", "Mangles strings"); assert(" asdf".trimLeft() === "asdf", "Fails to trim"); assert(" asdf".trimLeft() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trimLeft() === "asdf ", "Trims off the right"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.trimRight"] = function() { assert("asdf".trimRight() === "asdf", "Mangles strings"); assert("asdf ".trimRight() === "asdf", "Fails to trim"); assert("asdf ".trimRight() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trimRight() === " asdf", "Trims off the left"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.trim"] = function() { assert("asdf".trim() === "asdf", "Mangles strings"); assert(" asdf".trim() === "asdf", "Fails to trim"); assert("asdf ".trim() === "asdf", "Fails to trim"); assert(" asdf".trim() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trim() === "asdf", "Fails to trim both sides properly"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.strip"] = function() { assert("__asdfqwerty__".strip("_") === "asdfqwerty"); }; exports["string.stripLeft"] = function() { assert("__asdfqwerty__".stripLeft("_") === "asdfqwerty__"); }; exports["string.stripRight"] = function() { assert("__asdfqwerty__".stripRight("_") === "__asdfqwerty"); }; exports["string.pad"] = function() { assert("asdf".pad(2) === "asdf", "Mangles padding strings larger than pad length"); assert("asdf".pad(10) === " asdf "); assert("asdf".pad(10, "@") === "@@@asdf@@@", "Fails with character list"); assert("asdf".pad(8, "@!") === "@!asdf@!", "Fails with multi-character list"); assert("asdf".pad(7, "@!") === "@asdf@!", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.padLeft"] = function() { assert("asdf".padLeft(2) === "asdf", "Mangles padding strings larger than pad length"); assert("asdf".padLeft(10) === " asdf"); assert("asdf".padLeft(10, "@") === "@@@@@@asdf", "Fails with character list"); assert("asdf".padLeft(10, "@!") === "@!@!@!asdf", "Fails with multi-character list"); assert("asdf".padLeft(7, "@!") === "@!@asdf", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.padRight"] = function() { assert("asdf".padRight(2) === "asdf", "Mangles padding strings larger than pad length"); assert("asdf".padRight(10) === "asdf "); assert("asdf".padRight(10, "@") === "asdf@@@@@@", "Fails with character list"); assert("asdf".padRight(10, "@!") === "asdf@!@!@!", "Fails with multi-character list"); assert("asdf".padRight(7, "@!") === "asdf@!@", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.partition"] = function() { assert.match("foo=bar=baz".partition("="), ["foo", "=", "bar=baz"], "Fails on partition"); assert.match("foo-bar-baz".partition("="), ["foo-bar-baz", "", ""], "Fails on no partition"); }; exports["string.partitionRight"] = function() { assert.match("foo=bar=baz".partitionRight("="), ["foo=bar", "=", "baz"], "Fails on partition"); assert.match("foo-bar-baz".partitionRight("="), ["", "", "foo-bar-baz"], "Fails on no partition"); }; exports["string.explode"] = function() { var str = "foo,bar,baz"; assert.match(str.explode(','), str.split(','), "Explode with no limit does not give same output as .split"); - assert.match(str.explode(',', 2), ["foo","bar,baz"]); + assert.match(str.explode(',', 2), ["foo","bar,baz"], "Fails with limit"); + assert.match(str.explode(',', 3), ["foo","bar", "baz"], "Fails with even limit"); + assert.match(str.explode(',', 4), ["foo","bar", "baz"], "Fails with limit over the number of items"); + //var str = ".asdf.asdf.asdf"; + //assert.match(str.explode(/./), ["", "asdf", "asdf", "asdf"], "Fails on regex"); + //assert.match(str.explode(/^./g), ["", "asdf.asdf.asdf"], "Fails on /g regex using ^"); + //assert.match(str.explode(/^./), ["", "asdf.asdf.asdf"], "Fails on non-/g regex using ^"); }; exports["string.scan"] = function() { assert.match("foo bar baz".scan(/\w+/), ["foo","bar","baz"]); assert.match("foo bar baz".scan(/\w+/, 4), ["bar","baz"], "Fails on offset"); var s = "foo1 bar2 baz3".scan(/(\w+)(\d)/); assert.match(s[0], ["foo","1"], "Fails on groups"); assert.match(s[1], ["bar","2"], "Fails on groups"); assert.match(s[2], ["baz","3"], "Fails on groups"); assert("foo bar baz".scan(/(\w+)/)[0], ["foo"], "Fails on single group"); assert("foo bar baz".scan(/(\w+)/g)[0], ["foo"], "Fails on offset using groups"); }; exports["string.toCamelCase"] = function() { assert("camelCase".toCamelCase() === "camelCase", "Does not pass through existing camelCase strings"); assert("TitleCase".toCamelCase() === "TitleCase", "Mangles TitleCase strings"); assert("dash-string".toCamelCase() === "dashString", "Fails on dash-strings"); assert("dash-string-extend".toCamelCase() === "dashStringExtend", "Fails with more than one dash (missing /g likely)"); assert("-dash-string".toCamelCase() === "DashString", "Fails with - prefixed dash-strings"); assert("underscore_string".toCamelCase() === "underscoreString", "Fails on undescore_strings"); assert("-mixed_set-asdfString".toCamelCase() === "MixedSetAsdfString", "Fails on mixed"); }; exports["string.toUnderscore"] = function() { assert("underscore_string".toUnderscore() === "underscore_string", "Does not pass through existing undescore_strings"); assert("camelCase".toUnderscore() === "camel_case", "Failes on camelCase"); assert("camelCaseExtend".toUnderscore() === "camel_case_extend", "Fails with more than one hump (missing /g likely)"); assert("TitleCase".toUnderscore() === "_title_case", "Failes on TitleCase"); }; exports["string.toDash"] = function() { assert("dash-string".toDash() === "dash-string", "Does not pass through existing dash-strings"); assert("camelCase".toDash() === "camel-case", "Failes on camelCase"); assert("camelCaseExtend".toDash() === "camel-case-extend", "Fails with more than one hump (missing /g likely)"); assert("TitleCase".toDash() === "-title-case", "Failes on TitleCase"); };
dantman/wrench
81c5424d8fe96d9c69067dd0a1b1c9b12238915f
Fix shuffle test.
diff --git a/test/test.js b/test/test.js index e625d2b..c073fd4 100644 --- a/test/test.js +++ b/test/test.js @@ -1,55 +1,85 @@ function AssertionError(message) { return { constructor: Error, __proto__: Error.prototype, message: message, name: "AssertionError" }; } function PendingError() { return { constructor: AssertionError, __proto__: Error.prototype, message: "Pending", name: "PendingError" }; } function assert(ok, message) { if(!ok) throw new AssertionError(message || "Fail"); } assert.not = function(nok, message) { assert(!nok, message); }; +assert.noMatchOne = function(a, bs, message) { + next: + for ( var i = 0; i < bs.length; i++ ) { + var b = bs[i]; + // b is the hard test, a should match it + if ( b instanceof Array ) { + if(!(a instanceof Array)) + assert(false, message); + if( b.length !== a.length ) + continue; + for ( var i = 0; i < b.length; i++ ) { + if ( a[i] !== b[i] ) + continue next; + } + assert(false, message); + } else { + if( a instanceof Array ) + assert(false, message); + for ( var k in b ) { + if ( a.hasOwnProperty(k) && a[k] !== b[k] ) + continue next; + assert(false, message); + } + } + } + assert(true, message); +}; assert.matchOne = function(a, bs, message) { for ( var i = 0; i < bs.length; i++ ) { var b = bs[i]; // b is the hard test, a should match it if ( b instanceof Array ) { if(!(a instanceof Array)) assert(false, message); if( b.length !== a.length ) assert(false, message); for ( var i = 0; i < b.length; i++ ) if ( a[i] !== b[i] ) assert(false, message); } else { if( a instanceof Array ) assert(false, message); for ( var k in b ) { if ( a.hasOwnProperty(k) && a[k] === b[k] ) continue; assert(false, message); } } } assert(true, message); }; assert.match = function(a, b, message) { assert.matchOne(a, [b], message); }; +assert.nomatch = function(a, b, message) { + assert.noMatchOne(a, [b], message); +}; function pending() { throw new PendingError("Pending"); }; diff --git a/test/tests/Array.js b/test/tests/Array.js index ea73411..e858240 100644 --- a/test/tests/Array.js +++ b/test/tests/Array.js @@ -1,173 +1,173 @@ // Maybe we should just get rid of these two? // I didn't bother implementing tests for the rest of the array methods which come from MDC exports["array.indexOf"] = function() { var arr = [1,2,3,1,2,3]; assert(arr.indexOf(2) === 1, "indexOf not returning correct index"); assert(arr.indexOf(5) === -1, "indexOf did not return -1 for non-present index"); }; exports["array.lastIndexOf"] = function() { var arr = [1,2,3,1,2,3]; assert(arr.lastIndexOf(2) === 4, "lastIndexOf not returning correct index"); assert(arr.lastIndexOf(5) === -1, "lastIndexOf did not return -1 for non-present index"); }; exports["Array.fill()"] = function() { var arr = Array.fill(); assert(arr.length === 0, "Array length is not 0"); }; exports["Array.fill(5)"] = function() { var arr = Array.fill(5); assert(arr.length === 5, "Array length is not 5"); assert(arr[0] === undefined, "Array does not contain undefined items"); assert(arr[2] === undefined, "Array only fills one item"); }; exports["Array.fill(5, 5)"] = function() { var arr = Array.fill(5, 5); assert(arr.length === 5, "Array length is not 5"); assert(arr[0] === 5, "Array does not contain the number 5"); assert(arr[2] === 5, "Array only fills one item"); }; exports["Array.fill(2, {})"] = function() { var arr = Array.fill(2, {}); assert(arr.length === 2, "Array length is not 2"); assert(arr[0] === arr[1], "Array.fill copies objects rather than using the same one"); }; exports["array.repeat"] = function() { var a = []; assert.not(a.repeat() === a, "Modifies arrays instead of returning a new one"); assert.match([].repeat(0), []); assert.match([].repeat(1), []); assert.match([].repeat(2), []); assert.match(["foo", "bar", "baz"].repeat(0), [], "Does not return empty array on .repeat(0)"); assert.match(["foo", "bar", "baz"].repeat(1), ["foo", "bar", "baz"], "Does not pass through on .repeat(1)"); assert.match(["foo", "bar", "baz"].repeat(2), ["foo", "bar", "baz", "foo", "bar", "baz"], "Fails to repeat array"); assert.match(["foo", "bar", "baz"].repeat(5), ["foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz"], "Fails on repeats larger than 2"); }; exports["array.item"] = function() { var arr = ["foo", "bar"]; assert(arr[0] === arr.item(0) && arr[1] === arr.item(1)); }; exports["array.has"] = function() { assert(["foo", "bar", "baz"].has("bar")); assert.not(["foo", "bar", "baz"].has("zoo"), "False positives"); assert(["foo", "bar", "baz"].has("baz"), "Fails on match on last index"); assert(["foo", "bar", "baz"].has("foo"), "Fails on match on first index"); }; exports["array.remove"] = function() { var arr = ["foo", "bar", "baz"]; arr.remove("bar"); assert.match(arr, ["foo", "baz"]); var arr = ["foo", "bar", "baz"]; arr.remove("bar", 0); assert.match(arr, ["foo", "bar", "baz"], "Ignores 0 max"); var arr = ["foo", "bar", "baz"]; arr.remove("foo"); assert.match(arr, ["bar", "baz"], "Fails on match on first index"); var arr = ["foo", "bar", "baz"]; arr.remove("baz"); assert.match(arr, ["foo", "bar"], "Fails on match on first index"); var arr = ["foo", "bar", "baz", "foo", "foo"]; arr.remove("foo", 1); assert.match(arr, ["bar", "baz", "foo", "foo"], "Incorrect handling of multiple matches with explicit 1 (or new dominance?)"); var arr = ["foo", "bar", "baz", "foo", "foo"]; arr.remove("foo"); assert.match(arr, ["bar", "baz", "foo", "foo"], "Incorrect handling of multiple matches with implied 1"); var arr = ["foo", "bar", "baz", "foo", "foo"]; arr.remove("foo", 2); assert.match(arr, ["bar", "baz", "foo"], "Incorrect handling of multiple matches with specified 2"); var arr = ["foo", "bar", "baz", "foo", "foo"]; arr.remove("foo", Infinity); assert.match(arr, ["bar", "baz"], "Incorrect handling of multiple matches with specified Infinity"); var arr = ["foo", "bar", "baz", "foo", "foo"]; arr.remove("foo", -1); assert.match(arr, ["bar", "baz"], "Incorrect handling of multiple matches with specified Infinity"); }; exports["array.unique"] = function() { var a = []; assert.not(a.unique() === a, "Modifies arrays instead of returning a new one"); assert.match(["foo", "bar"].unique(), ["foo", "bar"], "Mangles arrays"); assert.match(["foo", "bar", "foo"].unique(), ["foo", "bar"]); }; exports["array.shuffle"] = function() { var arr = "abcdefghijklmnopqrstuvwxyz".split(''); // this has to be large to avoid getting the same array via .rand var rand = arr.slice(); assert(rand.shuffle() === rand, "Does not return the same array"); - assert.match(rand, arr, "Did not randomize (double check, there is a slim chance randomness could have returned the same array"); + assert.nomatch(rand, arr, "Did not randomize (double check, there is a slim chance randomness could have returned the same array"); }; exports["array.append"] = function() { var arr = ["foo", "bar"]; arr.append(["baz", "splat"]); assert.match(arr, ["foo", "bar", "baz", "splat"]); }; exports["array.clear"] = function() { var a = []; assert.not(a.clear() === a, "Not supposed to return old array"); var a = ["foo", "bar", "baz"]; var arr = a.clear(); assert.match(a, [], "Does not clear out array"); assert.match(arr, ["foo", "bar", "baz"], "Does not return copy of old array"); }; exports["array.clean"] = function() { var a = []; assert.not(a.clean() === a, "Modifies arrays instead of returning a new one"); assert.match(["foo", false, "bar", "", undefined, null, "baz"].clean(), ["foo", false, "bar", "", "baz"]); assert.match(["foo", false, "bar", "", undefined, null, "baz"].clean(false), ["foo", false, "bar", "", null, "baz"], "Fails on undefined only clean"); assert.match(["foo", false, "bar", "", undefined, null, "baz"].clean(true), ["foo", false, "bar", "baz"], "Fails on empty clean"); }; exports["array.rand"] = function() { pending(); }; exports["array.reduceNative"] = function() { assert([1,2,3].reduceNative(Math.max) === 3); assert([1,2,3].reduceNative(Math.min) === 1); assert([1,2,3].reduceNative(Math.sum) === 6, "Fails on custom Math.sum function"); }; exports["array.flat"] = function() { var arr = [1, 2, [3, [4, 5], 6], 7]; var flat = arr.flat(); assert.match(flat, [1, 2, 3, 4, 5, 6, 7]); assert(arr !== flat, "Mutates arrays rather than creating a new one"); }; exports["array.diff"] = function() { var a = ["a", "b"]; var b = ["b", "c"]; var i = a.diff(b); assert(i.length === 1, "Array is not the right size"); assert(a[0] === "a", "array.diff does not computer proper differences"); assert(i !== a && i !== b, "Mutates arrays rather than creating a new one"); }; exports["array.intersect"] = function() { var a = ["a", "b"]; var b = ["b", "c"]; var i = a.intersect(b); assert(i.length === 1, "Array is not the right size"); assert(i[0] === "b", "array.intersect does not compute proper intersections"); assert(i !== a && i !== b, "Mutates arrays rather than creating a new one"); };
dantman/wrench
320f7ffa30966ae02b77b355d683eee2672afab7
Add html test suite.
diff --git a/test/htmltest.js b/test/htmltest.js new file mode 100644 index 0000000..66ab028 --- /dev/null +++ b/test/htmltest.js @@ -0,0 +1,39 @@ + +var $results = $('#results tbody'); + +var $total = $('#total'); +var $passed = $('#passed'); +var $failed = $('#failed'); +var $pending = $('#pending'); + +var noRun = 0, noPassed = 0, noFailed = 0, noPending = 0; +for ( var test in exports ) { + var $result = $('<tr/>'); + $('<td/>').text(test).appendTo($result); + noRun++; + try { + exports[test](); + $('<td>Ok</td>').appendTo($result); + noPassed++; + $result.addClass('passed'); + } catch( e ) { + if ( e.name === "AssertionError" ) { + $('<td/>').text(e.message||"").appendTo($result); + $result.addClass('failed'); + noFailed++; + } else if ( e.name === "PendingError" ) { + $('<td>Pending</td>').appendTo($result); + noPending++; + $result.addClass('pending'); + } else { + $('<td>Threw error</td>').appendTo($result); + noFailed++; + $result.addClass('failed'); + } + } + $result.appendTo($results); + $total.text(noRun); + $passed.text(noPassed); + $failed.text(noFailed); + $pending.text(noPending); +} diff --git a/test/jquery-1.3.2.min.js b/test/jquery-1.3.2.min.js new file mode 100644 index 0000000..b1ae21d --- /dev/null +++ b/test/jquery-1.3.2.min.js @@ -0,0 +1,19 @@ +/* + * jQuery JavaScript Library v1.3.2 + * http://jquery.com/ + * + * Copyright (c) 2009 John Resig + * Dual licensed under the MIT and GPL licenses. + * http://docs.jquery.com/License + * + * Date: 2009-02-19 17:34:21 -0500 (Thu, 19 Feb 2009) + * Revision: 6246 + */ +(function(){var l=this,g,y=l.jQuery,p=l.$,o=l.jQuery=l.$=function(E,F){return new o.fn.init(E,F)},D=/^[^<]*(<(.|\s)+>)[^>]*$|^#([\w-]+)$/,f=/^.[^:#\[\.,]*$/;o.fn=o.prototype={init:function(E,H){E=E||document;if(E.nodeType){this[0]=E;this.length=1;this.context=E;return this}if(typeof E==="string"){var G=D.exec(E);if(G&&(G[1]||!H)){if(G[1]){E=o.clean([G[1]],H)}else{var I=document.getElementById(G[3]);if(I&&I.id!=G[3]){return o().find(E)}var F=o(I||[]);F.context=document;F.selector=E;return F}}else{return o(H).find(E)}}else{if(o.isFunction(E)){return o(document).ready(E)}}if(E.selector&&E.context){this.selector=E.selector;this.context=E.context}return this.setArray(o.isArray(E)?E:o.makeArray(E))},selector:"",jquery:"1.3.2",size:function(){return this.length},get:function(E){return E===g?Array.prototype.slice.call(this):this[E]},pushStack:function(F,H,E){var G=o(F);G.prevObject=this;G.context=this.context;if(H==="find"){G.selector=this.selector+(this.selector?" ":"")+E}else{if(H){G.selector=this.selector+"."+H+"("+E+")"}}return G},setArray:function(E){this.length=0;Array.prototype.push.apply(this,E);return this},each:function(F,E){return o.each(this,F,E)},index:function(E){return o.inArray(E&&E.jquery?E[0]:E,this)},attr:function(F,H,G){var E=F;if(typeof F==="string"){if(H===g){return this[0]&&o[G||"attr"](this[0],F)}else{E={};E[F]=H}}return this.each(function(I){for(F in E){o.attr(G?this.style:this,F,o.prop(this,E[F],G,I,F))}})},css:function(E,F){if((E=="width"||E=="height")&&parseFloat(F)<0){F=g}return this.attr(E,F,"curCSS")},text:function(F){if(typeof F!=="object"&&F!=null){return this.empty().append((this[0]&&this[0].ownerDocument||document).createTextNode(F))}var E="";o.each(F||this,function(){o.each(this.childNodes,function(){if(this.nodeType!=8){E+=this.nodeType!=1?this.nodeValue:o.fn.text([this])}})});return E},wrapAll:function(E){if(this[0]){var F=o(E,this[0].ownerDocument).clone();if(this[0].parentNode){F.insertBefore(this[0])}F.map(function(){var G=this;while(G.firstChild){G=G.firstChild}return G}).append(this)}return this},wrapInner:function(E){return this.each(function(){o(this).contents().wrapAll(E)})},wrap:function(E){return this.each(function(){o(this).wrapAll(E)})},append:function(){return this.domManip(arguments,true,function(E){if(this.nodeType==1){this.appendChild(E)}})},prepend:function(){return this.domManip(arguments,true,function(E){if(this.nodeType==1){this.insertBefore(E,this.firstChild)}})},before:function(){return this.domManip(arguments,false,function(E){this.parentNode.insertBefore(E,this)})},after:function(){return this.domManip(arguments,false,function(E){this.parentNode.insertBefore(E,this.nextSibling)})},end:function(){return this.prevObject||o([])},push:[].push,sort:[].sort,splice:[].splice,find:function(E){if(this.length===1){var F=this.pushStack([],"find",E);F.length=0;o.find(E,this[0],F);return F}else{return this.pushStack(o.unique(o.map(this,function(G){return o.find(E,G)})),"find",E)}},clone:function(G){var E=this.map(function(){if(!o.support.noCloneEvent&&!o.isXMLDoc(this)){var I=this.outerHTML;if(!I){var J=this.ownerDocument.createElement("div");J.appendChild(this.cloneNode(true));I=J.innerHTML}return o.clean([I.replace(/ jQuery\d+="(?:\d+|null)"/g,"").replace(/^\s*/,"")])[0]}else{return this.cloneNode(true)}});if(G===true){var H=this.find("*").andSelf(),F=0;E.find("*").andSelf().each(function(){if(this.nodeName!==H[F].nodeName){return}var I=o.data(H[F],"events");for(var K in I){for(var J in I[K]){o.event.add(this,K,I[K][J],I[K][J].data)}}F++})}return E},filter:function(E){return this.pushStack(o.isFunction(E)&&o.grep(this,function(G,F){return E.call(G,F)})||o.multiFilter(E,o.grep(this,function(F){return F.nodeType===1})),"filter",E)},closest:function(E){var G=o.expr.match.POS.test(E)?o(E):null,F=0;return this.map(function(){var H=this;while(H&&H.ownerDocument){if(G?G.index(H)>-1:o(H).is(E)){o.data(H,"closest",F);return H}H=H.parentNode;F++}})},not:function(E){if(typeof E==="string"){if(f.test(E)){return this.pushStack(o.multiFilter(E,this,true),"not",E)}else{E=o.multiFilter(E,this)}}var F=E.length&&E[E.length-1]!==g&&!E.nodeType;return this.filter(function(){return F?o.inArray(this,E)<0:this!=E})},add:function(E){return this.pushStack(o.unique(o.merge(this.get(),typeof E==="string"?o(E):o.makeArray(E))))},is:function(E){return !!E&&o.multiFilter(E,this).length>0},hasClass:function(E){return !!E&&this.is("."+E)},val:function(K){if(K===g){var E=this[0];if(E){if(o.nodeName(E,"option")){return(E.attributes.value||{}).specified?E.value:E.text}if(o.nodeName(E,"select")){var I=E.selectedIndex,L=[],M=E.options,H=E.type=="select-one";if(I<0){return null}for(var F=H?I:0,J=H?I+1:M.length;F<J;F++){var G=M[F];if(G.selected){K=o(G).val();if(H){return K}L.push(K)}}return L}return(E.value||"").replace(/\r/g,"")}return g}if(typeof K==="number"){K+=""}return this.each(function(){if(this.nodeType!=1){return}if(o.isArray(K)&&/radio|checkbox/.test(this.type)){this.checked=(o.inArray(this.value,K)>=0||o.inArray(this.name,K)>=0)}else{if(o.nodeName(this,"select")){var N=o.makeArray(K);o("option",this).each(function(){this.selected=(o.inArray(this.value,N)>=0||o.inArray(this.text,N)>=0)});if(!N.length){this.selectedIndex=-1}}else{this.value=K}}})},html:function(E){return E===g?(this[0]?this[0].innerHTML.replace(/ jQuery\d+="(?:\d+|null)"/g,""):null):this.empty().append(E)},replaceWith:function(E){return this.after(E).remove()},eq:function(E){return this.slice(E,+E+1)},slice:function(){return this.pushStack(Array.prototype.slice.apply(this,arguments),"slice",Array.prototype.slice.call(arguments).join(","))},map:function(E){return this.pushStack(o.map(this,function(G,F){return E.call(G,F,G)}))},andSelf:function(){return this.add(this.prevObject)},domManip:function(J,M,L){if(this[0]){var I=(this[0].ownerDocument||this[0]).createDocumentFragment(),F=o.clean(J,(this[0].ownerDocument||this[0]),I),H=I.firstChild;if(H){for(var G=0,E=this.length;G<E;G++){L.call(K(this[G],H),this.length>1||G>0?I.cloneNode(true):I)}}if(F){o.each(F,z)}}return this;function K(N,O){return M&&o.nodeName(N,"table")&&o.nodeName(O,"tr")?(N.getElementsByTagName("tbody")[0]||N.appendChild(N.ownerDocument.createElement("tbody"))):N}}};o.fn.init.prototype=o.fn;function z(E,F){if(F.src){o.ajax({url:F.src,async:false,dataType:"script"})}else{o.globalEval(F.text||F.textContent||F.innerHTML||"")}if(F.parentNode){F.parentNode.removeChild(F)}}function e(){return +new Date}o.extend=o.fn.extend=function(){var J=arguments[0]||{},H=1,I=arguments.length,E=false,G;if(typeof J==="boolean"){E=J;J=arguments[1]||{};H=2}if(typeof J!=="object"&&!o.isFunction(J)){J={}}if(I==H){J=this;--H}for(;H<I;H++){if((G=arguments[H])!=null){for(var F in G){var K=J[F],L=G[F];if(J===L){continue}if(E&&L&&typeof L==="object"&&!L.nodeType){J[F]=o.extend(E,K||(L.length!=null?[]:{}),L)}else{if(L!==g){J[F]=L}}}}}return J};var b=/z-?index|font-?weight|opacity|zoom|line-?height/i,q=document.defaultView||{},s=Object.prototype.toString;o.extend({noConflict:function(E){l.$=p;if(E){l.jQuery=y}return o},isFunction:function(E){return s.call(E)==="[object Function]"},isArray:function(E){return s.call(E)==="[object Array]"},isXMLDoc:function(E){return E.nodeType===9&&E.documentElement.nodeName!=="HTML"||!!E.ownerDocument&&o.isXMLDoc(E.ownerDocument)},globalEval:function(G){if(G&&/\S/.test(G)){var F=document.getElementsByTagName("head")[0]||document.documentElement,E=document.createElement("script");E.type="text/javascript";if(o.support.scriptEval){E.appendChild(document.createTextNode(G))}else{E.text=G}F.insertBefore(E,F.firstChild);F.removeChild(E)}},nodeName:function(F,E){return F.nodeName&&F.nodeName.toUpperCase()==E.toUpperCase()},each:function(G,K,F){var E,H=0,I=G.length;if(F){if(I===g){for(E in G){if(K.apply(G[E],F)===false){break}}}else{for(;H<I;){if(K.apply(G[H++],F)===false){break}}}}else{if(I===g){for(E in G){if(K.call(G[E],E,G[E])===false){break}}}else{for(var J=G[0];H<I&&K.call(J,H,J)!==false;J=G[++H]){}}}return G},prop:function(H,I,G,F,E){if(o.isFunction(I)){I=I.call(H,F)}return typeof I==="number"&&G=="curCSS"&&!b.test(E)?I+"px":I},className:{add:function(E,F){o.each((F||"").split(/\s+/),function(G,H){if(E.nodeType==1&&!o.className.has(E.className,H)){E.className+=(E.className?" ":"")+H}})},remove:function(E,F){if(E.nodeType==1){E.className=F!==g?o.grep(E.className.split(/\s+/),function(G){return !o.className.has(F,G)}).join(" "):""}},has:function(F,E){return F&&o.inArray(E,(F.className||F).toString().split(/\s+/))>-1}},swap:function(H,G,I){var E={};for(var F in G){E[F]=H.style[F];H.style[F]=G[F]}I.call(H);for(var F in G){H.style[F]=E[F]}},css:function(H,F,J,E){if(F=="width"||F=="height"){var L,G={position:"absolute",visibility:"hidden",display:"block"},K=F=="width"?["Left","Right"]:["Top","Bottom"];function I(){L=F=="width"?H.offsetWidth:H.offsetHeight;if(E==="border"){return}o.each(K,function(){if(!E){L-=parseFloat(o.curCSS(H,"padding"+this,true))||0}if(E==="margin"){L+=parseFloat(o.curCSS(H,"margin"+this,true))||0}else{L-=parseFloat(o.curCSS(H,"border"+this+"Width",true))||0}})}if(H.offsetWidth!==0){I()}else{o.swap(H,G,I)}return Math.max(0,Math.round(L))}return o.curCSS(H,F,J)},curCSS:function(I,F,G){var L,E=I.style;if(F=="opacity"&&!o.support.opacity){L=o.attr(E,"opacity");return L==""?"1":L}if(F.match(/float/i)){F=w}if(!G&&E&&E[F]){L=E[F]}else{if(q.getComputedStyle){if(F.match(/float/i)){F="float"}F=F.replace(/([A-Z])/g,"-$1").toLowerCase();var M=q.getComputedStyle(I,null);if(M){L=M.getPropertyValue(F)}if(F=="opacity"&&L==""){L="1"}}else{if(I.currentStyle){var J=F.replace(/\-(\w)/g,function(N,O){return O.toUpperCase()});L=I.currentStyle[F]||I.currentStyle[J];if(!/^\d+(px)?$/i.test(L)&&/^\d/.test(L)){var H=E.left,K=I.runtimeStyle.left;I.runtimeStyle.left=I.currentStyle.left;E.left=L||0;L=E.pixelLeft+"px";E.left=H;I.runtimeStyle.left=K}}}}return L},clean:function(F,K,I){K=K||document;if(typeof K.createElement==="undefined"){K=K.ownerDocument||K[0]&&K[0].ownerDocument||document}if(!I&&F.length===1&&typeof F[0]==="string"){var H=/^<(\w+)\s*\/?>$/.exec(F[0]);if(H){return[K.createElement(H[1])]}}var G=[],E=[],L=K.createElement("div");o.each(F,function(P,S){if(typeof S==="number"){S+=""}if(!S){return}if(typeof S==="string"){S=S.replace(/(<(\w+)[^>]*?)\/>/g,function(U,V,T){return T.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i)?U:V+"></"+T+">"});var O=S.replace(/^\s+/,"").substring(0,10).toLowerCase();var Q=!O.indexOf("<opt")&&[1,"<select multiple='multiple'>","</select>"]||!O.indexOf("<leg")&&[1,"<fieldset>","</fieldset>"]||O.match(/^<(thead|tbody|tfoot|colg|cap)/)&&[1,"<table>","</table>"]||!O.indexOf("<tr")&&[2,"<table><tbody>","</tbody></table>"]||(!O.indexOf("<td")||!O.indexOf("<th"))&&[3,"<table><tbody><tr>","</tr></tbody></table>"]||!O.indexOf("<col")&&[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"]||!o.support.htmlSerialize&&[1,"div<div>","</div>"]||[0,"",""];L.innerHTML=Q[1]+S+Q[2];while(Q[0]--){L=L.lastChild}if(!o.support.tbody){var R=/<tbody/i.test(S),N=!O.indexOf("<table")&&!R?L.firstChild&&L.firstChild.childNodes:Q[1]=="<table>"&&!R?L.childNodes:[];for(var M=N.length-1;M>=0;--M){if(o.nodeName(N[M],"tbody")&&!N[M].childNodes.length){N[M].parentNode.removeChild(N[M])}}}if(!o.support.leadingWhitespace&&/^\s/.test(S)){L.insertBefore(K.createTextNode(S.match(/^\s*/)[0]),L.firstChild)}S=o.makeArray(L.childNodes)}if(S.nodeType){G.push(S)}else{G=o.merge(G,S)}});if(I){for(var J=0;G[J];J++){if(o.nodeName(G[J],"script")&&(!G[J].type||G[J].type.toLowerCase()==="text/javascript")){E.push(G[J].parentNode?G[J].parentNode.removeChild(G[J]):G[J])}else{if(G[J].nodeType===1){G.splice.apply(G,[J+1,0].concat(o.makeArray(G[J].getElementsByTagName("script"))))}I.appendChild(G[J])}}return E}return G},attr:function(J,G,K){if(!J||J.nodeType==3||J.nodeType==8){return g}var H=!o.isXMLDoc(J),L=K!==g;G=H&&o.props[G]||G;if(J.tagName){var F=/href|src|style/.test(G);if(G=="selected"&&J.parentNode){J.parentNode.selectedIndex}if(G in J&&H&&!F){if(L){if(G=="type"&&o.nodeName(J,"input")&&J.parentNode){throw"type property can't be changed"}J[G]=K}if(o.nodeName(J,"form")&&J.getAttributeNode(G)){return J.getAttributeNode(G).nodeValue}if(G=="tabIndex"){var I=J.getAttributeNode("tabIndex");return I&&I.specified?I.value:J.nodeName.match(/(button|input|object|select|textarea)/i)?0:J.nodeName.match(/^(a|area)$/i)&&J.href?0:g}return J[G]}if(!o.support.style&&H&&G=="style"){return o.attr(J.style,"cssText",K)}if(L){J.setAttribute(G,""+K)}var E=!o.support.hrefNormalized&&H&&F?J.getAttribute(G,2):J.getAttribute(G);return E===null?g:E}if(!o.support.opacity&&G=="opacity"){if(L){J.zoom=1;J.filter=(J.filter||"").replace(/alpha\([^)]*\)/,"")+(parseInt(K)+""=="NaN"?"":"alpha(opacity="+K*100+")")}return J.filter&&J.filter.indexOf("opacity=")>=0?(parseFloat(J.filter.match(/opacity=([^)]*)/)[1])/100)+"":""}G=G.replace(/-([a-z])/ig,function(M,N){return N.toUpperCase()});if(L){J[G]=K}return J[G]},trim:function(E){return(E||"").replace(/^\s+|\s+$/g,"")},makeArray:function(G){var E=[];if(G!=null){var F=G.length;if(F==null||typeof G==="string"||o.isFunction(G)||G.setInterval){E[0]=G}else{while(F){E[--F]=G[F]}}}return E},inArray:function(G,H){for(var E=0,F=H.length;E<F;E++){if(H[E]===G){return E}}return -1},merge:function(H,E){var F=0,G,I=H.length;if(!o.support.getAll){while((G=E[F++])!=null){if(G.nodeType!=8){H[I++]=G}}}else{while((G=E[F++])!=null){H[I++]=G}}return H},unique:function(K){var F=[],E={};try{for(var G=0,H=K.length;G<H;G++){var J=o.data(K[G]);if(!E[J]){E[J]=true;F.push(K[G])}}}catch(I){F=K}return F},grep:function(F,J,E){var G=[];for(var H=0,I=F.length;H<I;H++){if(!E!=!J(F[H],H)){G.push(F[H])}}return G},map:function(E,J){var F=[];for(var G=0,H=E.length;G<H;G++){var I=J(E[G],G);if(I!=null){F[F.length]=I}}return F.concat.apply([],F)}});var C=navigator.userAgent.toLowerCase();o.browser={version:(C.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[0,"0"])[1],safari:/webkit/.test(C),opera:/opera/.test(C),msie:/msie/.test(C)&&!/opera/.test(C),mozilla:/mozilla/.test(C)&&!/(compatible|webkit)/.test(C)};o.each({parent:function(E){return E.parentNode},parents:function(E){return o.dir(E,"parentNode")},next:function(E){return o.nth(E,2,"nextSibling")},prev:function(E){return o.nth(E,2,"previousSibling")},nextAll:function(E){return o.dir(E,"nextSibling")},prevAll:function(E){return o.dir(E,"previousSibling")},siblings:function(E){return o.sibling(E.parentNode.firstChild,E)},children:function(E){return o.sibling(E.firstChild)},contents:function(E){return o.nodeName(E,"iframe")?E.contentDocument||E.contentWindow.document:o.makeArray(E.childNodes)}},function(E,F){o.fn[E]=function(G){var H=o.map(this,F);if(G&&typeof G=="string"){H=o.multiFilter(G,H)}return this.pushStack(o.unique(H),E,G)}});o.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(E,F){o.fn[E]=function(G){var J=[],L=o(G);for(var K=0,H=L.length;K<H;K++){var I=(K>0?this.clone(true):this).get();o.fn[F].apply(o(L[K]),I);J=J.concat(I)}return this.pushStack(J,E,G)}});o.each({removeAttr:function(E){o.attr(this,E,"");if(this.nodeType==1){this.removeAttribute(E)}},addClass:function(E){o.className.add(this,E)},removeClass:function(E){o.className.remove(this,E)},toggleClass:function(F,E){if(typeof E!=="boolean"){E=!o.className.has(this,F)}o.className[E?"add":"remove"](this,F)},remove:function(E){if(!E||o.filter(E,[this]).length){o("*",this).add([this]).each(function(){o.event.remove(this);o.removeData(this)});if(this.parentNode){this.parentNode.removeChild(this)}}},empty:function(){o(this).children().remove();while(this.firstChild){this.removeChild(this.firstChild)}}},function(E,F){o.fn[E]=function(){return this.each(F,arguments)}});function j(E,F){return E[0]&&parseInt(o.curCSS(E[0],F,true),10)||0}var h="jQuery"+e(),v=0,A={};o.extend({cache:{},data:function(F,E,G){F=F==l?A:F;var H=F[h];if(!H){H=F[h]=++v}if(E&&!o.cache[H]){o.cache[H]={}}if(G!==g){o.cache[H][E]=G}return E?o.cache[H][E]:H},removeData:function(F,E){F=F==l?A:F;var H=F[h];if(E){if(o.cache[H]){delete o.cache[H][E];E="";for(E in o.cache[H]){break}if(!E){o.removeData(F)}}}else{try{delete F[h]}catch(G){if(F.removeAttribute){F.removeAttribute(h)}}delete o.cache[H]}},queue:function(F,E,H){if(F){E=(E||"fx")+"queue";var G=o.data(F,E);if(!G||o.isArray(H)){G=o.data(F,E,o.makeArray(H))}else{if(H){G.push(H)}}}return G},dequeue:function(H,G){var E=o.queue(H,G),F=E.shift();if(!G||G==="fx"){F=E[0]}if(F!==g){F.call(H)}}});o.fn.extend({data:function(E,G){var H=E.split(".");H[1]=H[1]?"."+H[1]:"";if(G===g){var F=this.triggerHandler("getData"+H[1]+"!",[H[0]]);if(F===g&&this.length){F=o.data(this[0],E)}return F===g&&H[1]?this.data(H[0]):F}else{return this.trigger("setData"+H[1]+"!",[H[0],G]).each(function(){o.data(this,E,G)})}},removeData:function(E){return this.each(function(){o.removeData(this,E)})},queue:function(E,F){if(typeof E!=="string"){F=E;E="fx"}if(F===g){return o.queue(this[0],E)}return this.each(function(){var G=o.queue(this,E,F);if(E=="fx"&&G.length==1){G[0].call(this)}})},dequeue:function(E){return this.each(function(){o.dequeue(this,E)})}}); +/* + * Sizzle CSS Selector Engine - v0.9.3 + * Copyright 2009, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){var R=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?/g,L=0,H=Object.prototype.toString;var F=function(Y,U,ab,ac){ab=ab||[];U=U||document;if(U.nodeType!==1&&U.nodeType!==9){return[]}if(!Y||typeof Y!=="string"){return ab}var Z=[],W,af,ai,T,ad,V,X=true;R.lastIndex=0;while((W=R.exec(Y))!==null){Z.push(W[1]);if(W[2]){V=RegExp.rightContext;break}}if(Z.length>1&&M.exec(Y)){if(Z.length===2&&I.relative[Z[0]]){af=J(Z[0]+Z[1],U)}else{af=I.relative[Z[0]]?[U]:F(Z.shift(),U);while(Z.length){Y=Z.shift();if(I.relative[Y]){Y+=Z.shift()}af=J(Y,af)}}}else{var ae=ac?{expr:Z.pop(),set:E(ac)}:F.find(Z.pop(),Z.length===1&&U.parentNode?U.parentNode:U,Q(U));af=F.filter(ae.expr,ae.set);if(Z.length>0){ai=E(af)}else{X=false}while(Z.length){var ah=Z.pop(),ag=ah;if(!I.relative[ah]){ah=""}else{ag=Z.pop()}if(ag==null){ag=U}I.relative[ah](ai,ag,Q(U))}}if(!ai){ai=af}if(!ai){throw"Syntax error, unrecognized expression: "+(ah||Y)}if(H.call(ai)==="[object Array]"){if(!X){ab.push.apply(ab,ai)}else{if(U.nodeType===1){for(var aa=0;ai[aa]!=null;aa++){if(ai[aa]&&(ai[aa]===true||ai[aa].nodeType===1&&K(U,ai[aa]))){ab.push(af[aa])}}}else{for(var aa=0;ai[aa]!=null;aa++){if(ai[aa]&&ai[aa].nodeType===1){ab.push(af[aa])}}}}}else{E(ai,ab)}if(V){F(V,U,ab,ac);if(G){hasDuplicate=false;ab.sort(G);if(hasDuplicate){for(var aa=1;aa<ab.length;aa++){if(ab[aa]===ab[aa-1]){ab.splice(aa--,1)}}}}}return ab};F.matches=function(T,U){return F(T,null,null,U)};F.find=function(aa,T,ab){var Z,X;if(!aa){return[]}for(var W=0,V=I.order.length;W<V;W++){var Y=I.order[W],X;if((X=I.match[Y].exec(aa))){var U=RegExp.leftContext;if(U.substr(U.length-1)!=="\\"){X[1]=(X[1]||"").replace(/\\/g,"");Z=I.find[Y](X,T,ab);if(Z!=null){aa=aa.replace(I.match[Y],"");break}}}}if(!Z){Z=T.getElementsByTagName("*")}return{set:Z,expr:aa}};F.filter=function(ad,ac,ag,W){var V=ad,ai=[],aa=ac,Y,T,Z=ac&&ac[0]&&Q(ac[0]);while(ad&&ac.length){for(var ab in I.filter){if((Y=I.match[ab].exec(ad))!=null){var U=I.filter[ab],ah,af;T=false;if(aa==ai){ai=[]}if(I.preFilter[ab]){Y=I.preFilter[ab](Y,aa,ag,ai,W,Z);if(!Y){T=ah=true}else{if(Y===true){continue}}}if(Y){for(var X=0;(af=aa[X])!=null;X++){if(af){ah=U(af,Y,X,aa);var ae=W^!!ah;if(ag&&ah!=null){if(ae){T=true}else{aa[X]=false}}else{if(ae){ai.push(af);T=true}}}}}if(ah!==g){if(!ag){aa=ai}ad=ad.replace(I.match[ab],"");if(!T){return[]}break}}}if(ad==V){if(T==null){throw"Syntax error, unrecognized expression: "+ad}else{break}}V=ad}return aa};var I=F.selectors={order:["ID","NAME","TAG"],match:{ID:/#((?:[\w\u00c0-\uFFFF_-]|\\.)+)/,CLASS:/\.((?:[\w\u00c0-\uFFFF_-]|\\.)+)/,NAME:/\[name=['"]*((?:[\w\u00c0-\uFFFF_-]|\\.)+)['"]*\]/,ATTR:/\[\s*((?:[\w\u00c0-\uFFFF_-]|\\.)+)\s*(?:(\S?=)\s*(['"]*)(.*?)\3|)\s*\]/,TAG:/^((?:[\w\u00c0-\uFFFF\*_-]|\\.)+)/,CHILD:/:(only|nth|last|first)-child(?:\((even|odd|[\dn+-]*)\))?/,POS:/:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^-]|$)/,PSEUDO:/:((?:[\w\u00c0-\uFFFF_-]|\\.)+)(?:\((['"]*)((?:\([^\)]+\)|[^\2\(\)]*)+)\2\))?/},attrMap:{"class":"className","for":"htmlFor"},attrHandle:{href:function(T){return T.getAttribute("href")}},relative:{"+":function(aa,T,Z){var X=typeof T==="string",ab=X&&!/\W/.test(T),Y=X&&!ab;if(ab&&!Z){T=T.toUpperCase()}for(var W=0,V=aa.length,U;W<V;W++){if((U=aa[W])){while((U=U.previousSibling)&&U.nodeType!==1){}aa[W]=Y||U&&U.nodeName===T?U||false:U===T}}if(Y){F.filter(T,aa,true)}},">":function(Z,U,aa){var X=typeof U==="string";if(X&&!/\W/.test(U)){U=aa?U:U.toUpperCase();for(var V=0,T=Z.length;V<T;V++){var Y=Z[V];if(Y){var W=Y.parentNode;Z[V]=W.nodeName===U?W:false}}}else{for(var V=0,T=Z.length;V<T;V++){var Y=Z[V];if(Y){Z[V]=X?Y.parentNode:Y.parentNode===U}}if(X){F.filter(U,Z,true)}}},"":function(W,U,Y){var V=L++,T=S;if(!U.match(/\W/)){var X=U=Y?U:U.toUpperCase();T=P}T("parentNode",U,V,W,X,Y)},"~":function(W,U,Y){var V=L++,T=S;if(typeof U==="string"&&!U.match(/\W/)){var X=U=Y?U:U.toUpperCase();T=P}T("previousSibling",U,V,W,X,Y)}},find:{ID:function(U,V,W){if(typeof V.getElementById!=="undefined"&&!W){var T=V.getElementById(U[1]);return T?[T]:[]}},NAME:function(V,Y,Z){if(typeof Y.getElementsByName!=="undefined"){var U=[],X=Y.getElementsByName(V[1]);for(var W=0,T=X.length;W<T;W++){if(X[W].getAttribute("name")===V[1]){U.push(X[W])}}return U.length===0?null:U}},TAG:function(T,U){return U.getElementsByTagName(T[1])}},preFilter:{CLASS:function(W,U,V,T,Z,aa){W=" "+W[1].replace(/\\/g,"")+" ";if(aa){return W}for(var X=0,Y;(Y=U[X])!=null;X++){if(Y){if(Z^(Y.className&&(" "+Y.className+" ").indexOf(W)>=0)){if(!V){T.push(Y)}}else{if(V){U[X]=false}}}}return false},ID:function(T){return T[1].replace(/\\/g,"")},TAG:function(U,T){for(var V=0;T[V]===false;V++){}return T[V]&&Q(T[V])?U[1]:U[1].toUpperCase()},CHILD:function(T){if(T[1]=="nth"){var U=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(T[2]=="even"&&"2n"||T[2]=="odd"&&"2n+1"||!/\D/.test(T[2])&&"0n+"+T[2]||T[2]);T[2]=(U[1]+(U[2]||1))-0;T[3]=U[3]-0}T[0]=L++;return T},ATTR:function(X,U,V,T,Y,Z){var W=X[1].replace(/\\/g,"");if(!Z&&I.attrMap[W]){X[1]=I.attrMap[W]}if(X[2]==="~="){X[4]=" "+X[4]+" "}return X},PSEUDO:function(X,U,V,T,Y){if(X[1]==="not"){if(X[3].match(R).length>1||/^\w/.test(X[3])){X[3]=F(X[3],null,null,U)}else{var W=F.filter(X[3],U,V,true^Y);if(!V){T.push.apply(T,W)}return false}}else{if(I.match.POS.test(X[0])||I.match.CHILD.test(X[0])){return true}}return X},POS:function(T){T.unshift(true);return T}},filters:{enabled:function(T){return T.disabled===false&&T.type!=="hidden"},disabled:function(T){return T.disabled===true},checked:function(T){return T.checked===true},selected:function(T){T.parentNode.selectedIndex;return T.selected===true},parent:function(T){return !!T.firstChild},empty:function(T){return !T.firstChild},has:function(V,U,T){return !!F(T[3],V).length},header:function(T){return/h\d/i.test(T.nodeName)},text:function(T){return"text"===T.type},radio:function(T){return"radio"===T.type},checkbox:function(T){return"checkbox"===T.type},file:function(T){return"file"===T.type},password:function(T){return"password"===T.type},submit:function(T){return"submit"===T.type},image:function(T){return"image"===T.type},reset:function(T){return"reset"===T.type},button:function(T){return"button"===T.type||T.nodeName.toUpperCase()==="BUTTON"},input:function(T){return/input|select|textarea|button/i.test(T.nodeName)}},setFilters:{first:function(U,T){return T===0},last:function(V,U,T,W){return U===W.length-1},even:function(U,T){return T%2===0},odd:function(U,T){return T%2===1},lt:function(V,U,T){return U<T[3]-0},gt:function(V,U,T){return U>T[3]-0},nth:function(V,U,T){return T[3]-0==U},eq:function(V,U,T){return T[3]-0==U}},filter:{PSEUDO:function(Z,V,W,aa){var U=V[1],X=I.filters[U];if(X){return X(Z,W,V,aa)}else{if(U==="contains"){return(Z.textContent||Z.innerText||"").indexOf(V[3])>=0}else{if(U==="not"){var Y=V[3];for(var W=0,T=Y.length;W<T;W++){if(Y[W]===Z){return false}}return true}}}},CHILD:function(T,W){var Z=W[1],U=T;switch(Z){case"only":case"first":while(U=U.previousSibling){if(U.nodeType===1){return false}}if(Z=="first"){return true}U=T;case"last":while(U=U.nextSibling){if(U.nodeType===1){return false}}return true;case"nth":var V=W[2],ac=W[3];if(V==1&&ac==0){return true}var Y=W[0],ab=T.parentNode;if(ab&&(ab.sizcache!==Y||!T.nodeIndex)){var X=0;for(U=ab.firstChild;U;U=U.nextSibling){if(U.nodeType===1){U.nodeIndex=++X}}ab.sizcache=Y}var aa=T.nodeIndex-ac;if(V==0){return aa==0}else{return(aa%V==0&&aa/V>=0)}}},ID:function(U,T){return U.nodeType===1&&U.getAttribute("id")===T},TAG:function(U,T){return(T==="*"&&U.nodeType===1)||U.nodeName===T},CLASS:function(U,T){return(" "+(U.className||U.getAttribute("class"))+" ").indexOf(T)>-1},ATTR:function(Y,W){var V=W[1],T=I.attrHandle[V]?I.attrHandle[V](Y):Y[V]!=null?Y[V]:Y.getAttribute(V),Z=T+"",X=W[2],U=W[4];return T==null?X==="!=":X==="="?Z===U:X==="*="?Z.indexOf(U)>=0:X==="~="?(" "+Z+" ").indexOf(U)>=0:!U?Z&&T!==false:X==="!="?Z!=U:X==="^="?Z.indexOf(U)===0:X==="$="?Z.substr(Z.length-U.length)===U:X==="|="?Z===U||Z.substr(0,U.length+1)===U+"-":false},POS:function(X,U,V,Y){var T=U[2],W=I.setFilters[T];if(W){return W(X,V,U,Y)}}}};var M=I.match.POS;for(var O in I.match){I.match[O]=RegExp(I.match[O].source+/(?![^\[]*\])(?![^\(]*\))/.source)}var E=function(U,T){U=Array.prototype.slice.call(U);if(T){T.push.apply(T,U);return T}return U};try{Array.prototype.slice.call(document.documentElement.childNodes)}catch(N){E=function(X,W){var U=W||[];if(H.call(X)==="[object Array]"){Array.prototype.push.apply(U,X)}else{if(typeof X.length==="number"){for(var V=0,T=X.length;V<T;V++){U.push(X[V])}}else{for(var V=0;X[V];V++){U.push(X[V])}}}return U}}var G;if(document.documentElement.compareDocumentPosition){G=function(U,T){var V=U.compareDocumentPosition(T)&4?-1:U===T?0:1;if(V===0){hasDuplicate=true}return V}}else{if("sourceIndex" in document.documentElement){G=function(U,T){var V=U.sourceIndex-T.sourceIndex;if(V===0){hasDuplicate=true}return V}}else{if(document.createRange){G=function(W,U){var V=W.ownerDocument.createRange(),T=U.ownerDocument.createRange();V.selectNode(W);V.collapse(true);T.selectNode(U);T.collapse(true);var X=V.compareBoundaryPoints(Range.START_TO_END,T);if(X===0){hasDuplicate=true}return X}}}}(function(){var U=document.createElement("form"),V="script"+(new Date).getTime();U.innerHTML="<input name='"+V+"'/>";var T=document.documentElement;T.insertBefore(U,T.firstChild);if(!!document.getElementById(V)){I.find.ID=function(X,Y,Z){if(typeof Y.getElementById!=="undefined"&&!Z){var W=Y.getElementById(X[1]);return W?W.id===X[1]||typeof W.getAttributeNode!=="undefined"&&W.getAttributeNode("id").nodeValue===X[1]?[W]:g:[]}};I.filter.ID=function(Y,W){var X=typeof Y.getAttributeNode!=="undefined"&&Y.getAttributeNode("id");return Y.nodeType===1&&X&&X.nodeValue===W}}T.removeChild(U)})();(function(){var T=document.createElement("div");T.appendChild(document.createComment(""));if(T.getElementsByTagName("*").length>0){I.find.TAG=function(U,Y){var X=Y.getElementsByTagName(U[1]);if(U[1]==="*"){var W=[];for(var V=0;X[V];V++){if(X[V].nodeType===1){W.push(X[V])}}X=W}return X}}T.innerHTML="<a href='#'></a>";if(T.firstChild&&typeof T.firstChild.getAttribute!=="undefined"&&T.firstChild.getAttribute("href")!=="#"){I.attrHandle.href=function(U){return U.getAttribute("href",2)}}})();if(document.querySelectorAll){(function(){var T=F,U=document.createElement("div");U.innerHTML="<p class='TEST'></p>";if(U.querySelectorAll&&U.querySelectorAll(".TEST").length===0){return}F=function(Y,X,V,W){X=X||document;if(!W&&X.nodeType===9&&!Q(X)){try{return E(X.querySelectorAll(Y),V)}catch(Z){}}return T(Y,X,V,W)};F.find=T.find;F.filter=T.filter;F.selectors=T.selectors;F.matches=T.matches})()}if(document.getElementsByClassName&&document.documentElement.getElementsByClassName){(function(){var T=document.createElement("div");T.innerHTML="<div class='test e'></div><div class='test'></div>";if(T.getElementsByClassName("e").length===0){return}T.lastChild.className="e";if(T.getElementsByClassName("e").length===1){return}I.order.splice(1,0,"CLASS");I.find.CLASS=function(U,V,W){if(typeof V.getElementsByClassName!=="undefined"&&!W){return V.getElementsByClassName(U[1])}}})()}function P(U,Z,Y,ad,aa,ac){var ab=U=="previousSibling"&&!ac;for(var W=0,V=ad.length;W<V;W++){var T=ad[W];if(T){if(ab&&T.nodeType===1){T.sizcache=Y;T.sizset=W}T=T[U];var X=false;while(T){if(T.sizcache===Y){X=ad[T.sizset];break}if(T.nodeType===1&&!ac){T.sizcache=Y;T.sizset=W}if(T.nodeName===Z){X=T;break}T=T[U]}ad[W]=X}}}function S(U,Z,Y,ad,aa,ac){var ab=U=="previousSibling"&&!ac;for(var W=0,V=ad.length;W<V;W++){var T=ad[W];if(T){if(ab&&T.nodeType===1){T.sizcache=Y;T.sizset=W}T=T[U];var X=false;while(T){if(T.sizcache===Y){X=ad[T.sizset];break}if(T.nodeType===1){if(!ac){T.sizcache=Y;T.sizset=W}if(typeof Z!=="string"){if(T===Z){X=true;break}}else{if(F.filter(Z,[T]).length>0){X=T;break}}}T=T[U]}ad[W]=X}}}var K=document.compareDocumentPosition?function(U,T){return U.compareDocumentPosition(T)&16}:function(U,T){return U!==T&&(U.contains?U.contains(T):true)};var Q=function(T){return T.nodeType===9&&T.documentElement.nodeName!=="HTML"||!!T.ownerDocument&&Q(T.ownerDocument)};var J=function(T,aa){var W=[],X="",Y,V=aa.nodeType?[aa]:aa;while((Y=I.match.PSEUDO.exec(T))){X+=Y[0];T=T.replace(I.match.PSEUDO,"")}T=I.relative[T]?T+"*":T;for(var Z=0,U=V.length;Z<U;Z++){F(T,V[Z],W)}return F.filter(X,W)};o.find=F;o.filter=F.filter;o.expr=F.selectors;o.expr[":"]=o.expr.filters;F.selectors.filters.hidden=function(T){return T.offsetWidth===0||T.offsetHeight===0};F.selectors.filters.visible=function(T){return T.offsetWidth>0||T.offsetHeight>0};F.selectors.filters.animated=function(T){return o.grep(o.timers,function(U){return T===U.elem}).length};o.multiFilter=function(V,T,U){if(U){V=":not("+V+")"}return F.matches(V,T)};o.dir=function(V,U){var T=[],W=V[U];while(W&&W!=document){if(W.nodeType==1){T.push(W)}W=W[U]}return T};o.nth=function(X,T,V,W){T=T||1;var U=0;for(;X;X=X[V]){if(X.nodeType==1&&++U==T){break}}return X};o.sibling=function(V,U){var T=[];for(;V;V=V.nextSibling){if(V.nodeType==1&&V!=U){T.push(V)}}return T};return;l.Sizzle=F})();o.event={add:function(I,F,H,K){if(I.nodeType==3||I.nodeType==8){return}if(I.setInterval&&I!=l){I=l}if(!H.guid){H.guid=this.guid++}if(K!==g){var G=H;H=this.proxy(G);H.data=K}var E=o.data(I,"events")||o.data(I,"events",{}),J=o.data(I,"handle")||o.data(I,"handle",function(){return typeof o!=="undefined"&&!o.event.triggered?o.event.handle.apply(arguments.callee.elem,arguments):g});J.elem=I;o.each(F.split(/\s+/),function(M,N){var O=N.split(".");N=O.shift();H.type=O.slice().sort().join(".");var L=E[N];if(o.event.specialAll[N]){o.event.specialAll[N].setup.call(I,K,O)}if(!L){L=E[N]={};if(!o.event.special[N]||o.event.special[N].setup.call(I,K,O)===false){if(I.addEventListener){I.addEventListener(N,J,false)}else{if(I.attachEvent){I.attachEvent("on"+N,J)}}}}L[H.guid]=H;o.event.global[N]=true});I=null},guid:1,global:{},remove:function(K,H,J){if(K.nodeType==3||K.nodeType==8){return}var G=o.data(K,"events"),F,E;if(G){if(H===g||(typeof H==="string"&&H.charAt(0)==".")){for(var I in G){this.remove(K,I+(H||""))}}else{if(H.type){J=H.handler;H=H.type}o.each(H.split(/\s+/),function(M,O){var Q=O.split(".");O=Q.shift();var N=RegExp("(^|\\.)"+Q.slice().sort().join(".*\\.")+"(\\.|$)");if(G[O]){if(J){delete G[O][J.guid]}else{for(var P in G[O]){if(N.test(G[O][P].type)){delete G[O][P]}}}if(o.event.specialAll[O]){o.event.specialAll[O].teardown.call(K,Q)}for(F in G[O]){break}if(!F){if(!o.event.special[O]||o.event.special[O].teardown.call(K,Q)===false){if(K.removeEventListener){K.removeEventListener(O,o.data(K,"handle"),false)}else{if(K.detachEvent){K.detachEvent("on"+O,o.data(K,"handle"))}}}F=null;delete G[O]}}})}for(F in G){break}if(!F){var L=o.data(K,"handle");if(L){L.elem=null}o.removeData(K,"events");o.removeData(K,"handle")}}},trigger:function(I,K,H,E){var G=I.type||I;if(!E){I=typeof I==="object"?I[h]?I:o.extend(o.Event(G),I):o.Event(G);if(G.indexOf("!")>=0){I.type=G=G.slice(0,-1);I.exclusive=true}if(!H){I.stopPropagation();if(this.global[G]){o.each(o.cache,function(){if(this.events&&this.events[G]){o.event.trigger(I,K,this.handle.elem)}})}}if(!H||H.nodeType==3||H.nodeType==8){return g}I.result=g;I.target=H;K=o.makeArray(K);K.unshift(I)}I.currentTarget=H;var J=o.data(H,"handle");if(J){J.apply(H,K)}if((!H[G]||(o.nodeName(H,"a")&&G=="click"))&&H["on"+G]&&H["on"+G].apply(H,K)===false){I.result=false}if(!E&&H[G]&&!I.isDefaultPrevented()&&!(o.nodeName(H,"a")&&G=="click")){this.triggered=true;try{H[G]()}catch(L){}}this.triggered=false;if(!I.isPropagationStopped()){var F=H.parentNode||H.ownerDocument;if(F){o.event.trigger(I,K,F,true)}}},handle:function(K){var J,E;K=arguments[0]=o.event.fix(K||l.event);K.currentTarget=this;var L=K.type.split(".");K.type=L.shift();J=!L.length&&!K.exclusive;var I=RegExp("(^|\\.)"+L.slice().sort().join(".*\\.")+"(\\.|$)");E=(o.data(this,"events")||{})[K.type];for(var G in E){var H=E[G];if(J||I.test(H.type)){K.handler=H;K.data=H.data;var F=H.apply(this,arguments);if(F!==g){K.result=F;if(F===false){K.preventDefault();K.stopPropagation()}}if(K.isImmediatePropagationStopped()){break}}}},props:"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which".split(" "),fix:function(H){if(H[h]){return H}var F=H;H=o.Event(F);for(var G=this.props.length,J;G;){J=this.props[--G];H[J]=F[J]}if(!H.target){H.target=H.srcElement||document}if(H.target.nodeType==3){H.target=H.target.parentNode}if(!H.relatedTarget&&H.fromElement){H.relatedTarget=H.fromElement==H.target?H.toElement:H.fromElement}if(H.pageX==null&&H.clientX!=null){var I=document.documentElement,E=document.body;H.pageX=H.clientX+(I&&I.scrollLeft||E&&E.scrollLeft||0)-(I.clientLeft||0);H.pageY=H.clientY+(I&&I.scrollTop||E&&E.scrollTop||0)-(I.clientTop||0)}if(!H.which&&((H.charCode||H.charCode===0)?H.charCode:H.keyCode)){H.which=H.charCode||H.keyCode}if(!H.metaKey&&H.ctrlKey){H.metaKey=H.ctrlKey}if(!H.which&&H.button){H.which=(H.button&1?1:(H.button&2?3:(H.button&4?2:0)))}return H},proxy:function(F,E){E=E||function(){return F.apply(this,arguments)};E.guid=F.guid=F.guid||E.guid||this.guid++;return E},special:{ready:{setup:B,teardown:function(){}}},specialAll:{live:{setup:function(E,F){o.event.add(this,F[0],c)},teardown:function(G){if(G.length){var E=0,F=RegExp("(^|\\.)"+G[0]+"(\\.|$)");o.each((o.data(this,"events").live||{}),function(){if(F.test(this.type)){E++}});if(E<1){o.event.remove(this,G[0],c)}}}}}};o.Event=function(E){if(!this.preventDefault){return new o.Event(E)}if(E&&E.type){this.originalEvent=E;this.type=E.type}else{this.type=E}this.timeStamp=e();this[h]=true};function k(){return false}function u(){return true}o.Event.prototype={preventDefault:function(){this.isDefaultPrevented=u;var E=this.originalEvent;if(!E){return}if(E.preventDefault){E.preventDefault()}E.returnValue=false},stopPropagation:function(){this.isPropagationStopped=u;var E=this.originalEvent;if(!E){return}if(E.stopPropagation){E.stopPropagation()}E.cancelBubble=true},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=u;this.stopPropagation()},isDefaultPrevented:k,isPropagationStopped:k,isImmediatePropagationStopped:k};var a=function(F){var E=F.relatedTarget;while(E&&E!=this){try{E=E.parentNode}catch(G){E=this}}if(E!=this){F.type=F.data;o.event.handle.apply(this,arguments)}};o.each({mouseover:"mouseenter",mouseout:"mouseleave"},function(F,E){o.event.special[E]={setup:function(){o.event.add(this,F,a,E)},teardown:function(){o.event.remove(this,F,a)}}});o.fn.extend({bind:function(F,G,E){return F=="unload"?this.one(F,G,E):this.each(function(){o.event.add(this,F,E||G,E&&G)})},one:function(G,H,F){var E=o.event.proxy(F||H,function(I){o(this).unbind(I,E);return(F||H).apply(this,arguments)});return this.each(function(){o.event.add(this,G,E,F&&H)})},unbind:function(F,E){return this.each(function(){o.event.remove(this,F,E)})},trigger:function(E,F){return this.each(function(){o.event.trigger(E,F,this)})},triggerHandler:function(E,G){if(this[0]){var F=o.Event(E);F.preventDefault();F.stopPropagation();o.event.trigger(F,G,this[0]);return F.result}},toggle:function(G){var E=arguments,F=1;while(F<E.length){o.event.proxy(G,E[F++])}return this.click(o.event.proxy(G,function(H){this.lastToggle=(this.lastToggle||0)%F;H.preventDefault();return E[this.lastToggle++].apply(this,arguments)||false}))},hover:function(E,F){return this.mouseenter(E).mouseleave(F)},ready:function(E){B();if(o.isReady){E.call(document,o)}else{o.readyList.push(E)}return this},live:function(G,F){var E=o.event.proxy(F);E.guid+=this.selector+G;o(document).bind(i(G,this.selector),this.selector,E);return this},die:function(F,E){o(document).unbind(i(F,this.selector),E?{guid:E.guid+this.selector+F}:null);return this}});function c(H){var E=RegExp("(^|\\.)"+H.type+"(\\.|$)"),G=true,F=[];o.each(o.data(this,"events").live||[],function(I,J){if(E.test(J.type)){var K=o(H.target).closest(J.data)[0];if(K){F.push({elem:K,fn:J})}}});F.sort(function(J,I){return o.data(J.elem,"closest")-o.data(I.elem,"closest")});o.each(F,function(){if(this.fn.call(this.elem,H,this.fn.data)===false){return(G=false)}});return G}function i(F,E){return["live",F,E.replace(/\./g,"`").replace(/ /g,"|")].join(".")}o.extend({isReady:false,readyList:[],ready:function(){if(!o.isReady){o.isReady=true;if(o.readyList){o.each(o.readyList,function(){this.call(document,o)});o.readyList=null}o(document).triggerHandler("ready")}}});var x=false;function B(){if(x){return}x=true;if(document.addEventListener){document.addEventListener("DOMContentLoaded",function(){document.removeEventListener("DOMContentLoaded",arguments.callee,false);o.ready()},false)}else{if(document.attachEvent){document.attachEvent("onreadystatechange",function(){if(document.readyState==="complete"){document.detachEvent("onreadystatechange",arguments.callee);o.ready()}});if(document.documentElement.doScroll&&l==l.top){(function(){if(o.isReady){return}try{document.documentElement.doScroll("left")}catch(E){setTimeout(arguments.callee,0);return}o.ready()})()}}}o.event.add(l,"load",o.ready)}o.each(("blur,focus,load,resize,scroll,unload,click,dblclick,mousedown,mouseup,mousemove,mouseover,mouseout,mouseenter,mouseleave,change,select,submit,keydown,keypress,keyup,error").split(","),function(F,E){o.fn[E]=function(G){return G?this.bind(E,G):this.trigger(E)}});o(l).bind("unload",function(){for(var E in o.cache){if(E!=1&&o.cache[E].handle){o.event.remove(o.cache[E].handle.elem)}}});(function(){o.support={};var F=document.documentElement,G=document.createElement("script"),K=document.createElement("div"),J="script"+(new Date).getTime();K.style.display="none";K.innerHTML=' <link/><table></table><a href="/a" style="color:red;float:left;opacity:.5;">a</a><select><option>text</option></select><object><param/></object>';var H=K.getElementsByTagName("*"),E=K.getElementsByTagName("a")[0];if(!H||!H.length||!E){return}o.support={leadingWhitespace:K.firstChild.nodeType==3,tbody:!K.getElementsByTagName("tbody").length,objectAll:!!K.getElementsByTagName("object")[0].getElementsByTagName("*").length,htmlSerialize:!!K.getElementsByTagName("link").length,style:/red/.test(E.getAttribute("style")),hrefNormalized:E.getAttribute("href")==="/a",opacity:E.style.opacity==="0.5",cssFloat:!!E.style.cssFloat,scriptEval:false,noCloneEvent:true,boxModel:null};G.type="text/javascript";try{G.appendChild(document.createTextNode("window."+J+"=1;"))}catch(I){}F.insertBefore(G,F.firstChild);if(l[J]){o.support.scriptEval=true;delete l[J]}F.removeChild(G);if(K.attachEvent&&K.fireEvent){K.attachEvent("onclick",function(){o.support.noCloneEvent=false;K.detachEvent("onclick",arguments.callee)});K.cloneNode(true).fireEvent("onclick")}o(function(){var L=document.createElement("div");L.style.width=L.style.paddingLeft="1px";document.body.appendChild(L);o.boxModel=o.support.boxModel=L.offsetWidth===2;document.body.removeChild(L).style.display="none"})})();var w=o.support.cssFloat?"cssFloat":"styleFloat";o.props={"for":"htmlFor","class":"className","float":w,cssFloat:w,styleFloat:w,readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",tabindex:"tabIndex"};o.fn.extend({_load:o.fn.load,load:function(G,J,K){if(typeof G!=="string"){return this._load(G)}var I=G.indexOf(" ");if(I>=0){var E=G.slice(I,G.length);G=G.slice(0,I)}var H="GET";if(J){if(o.isFunction(J)){K=J;J=null}else{if(typeof J==="object"){J=o.param(J);H="POST"}}}var F=this;o.ajax({url:G,type:H,dataType:"html",data:J,complete:function(M,L){if(L=="success"||L=="notmodified"){F.html(E?o("<div/>").append(M.responseText.replace(/<script(.|\s)*?\/script>/g,"")).find(E):M.responseText)}if(K){F.each(K,[M.responseText,L,M])}}});return this},serialize:function(){return o.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?o.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password|search/i.test(this.type))}).map(function(E,F){var G=o(this).val();return G==null?null:o.isArray(G)?o.map(G,function(I,H){return{name:F.name,value:I}}):{name:F.name,value:G}}).get()}});o.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(E,F){o.fn[F]=function(G){return this.bind(F,G)}});var r=e();o.extend({get:function(E,G,H,F){if(o.isFunction(G)){H=G;G=null}return o.ajax({type:"GET",url:E,data:G,success:H,dataType:F})},getScript:function(E,F){return o.get(E,null,F,"script")},getJSON:function(E,F,G){return o.get(E,F,G,"json")},post:function(E,G,H,F){if(o.isFunction(G)){H=G;G={}}return o.ajax({type:"POST",url:E,data:G,success:H,dataType:F})},ajaxSetup:function(E){o.extend(o.ajaxSettings,E)},ajaxSettings:{url:location.href,global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:function(){return l.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest()},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(M){M=o.extend(true,M,o.extend(true,{},o.ajaxSettings,M));var W,F=/=\?(&|$)/g,R,V,G=M.type.toUpperCase();if(M.data&&M.processData&&typeof M.data!=="string"){M.data=o.param(M.data)}if(M.dataType=="jsonp"){if(G=="GET"){if(!M.url.match(F)){M.url+=(M.url.match(/\?/)?"&":"?")+(M.jsonp||"callback")+"=?"}}else{if(!M.data||!M.data.match(F)){M.data=(M.data?M.data+"&":"")+(M.jsonp||"callback")+"=?"}}M.dataType="json"}if(M.dataType=="json"&&(M.data&&M.data.match(F)||M.url.match(F))){W="jsonp"+r++;if(M.data){M.data=(M.data+"").replace(F,"="+W+"$1")}M.url=M.url.replace(F,"="+W+"$1");M.dataType="script";l[W]=function(X){V=X;I();L();l[W]=g;try{delete l[W]}catch(Y){}if(H){H.removeChild(T)}}}if(M.dataType=="script"&&M.cache==null){M.cache=false}if(M.cache===false&&G=="GET"){var E=e();var U=M.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+E+"$2");M.url=U+((U==M.url)?(M.url.match(/\?/)?"&":"?")+"_="+E:"")}if(M.data&&G=="GET"){M.url+=(M.url.match(/\?/)?"&":"?")+M.data;M.data=null}if(M.global&&!o.active++){o.event.trigger("ajaxStart")}var Q=/^(\w+:)?\/\/([^\/?#]+)/.exec(M.url);if(M.dataType=="script"&&G=="GET"&&Q&&(Q[1]&&Q[1]!=location.protocol||Q[2]!=location.host)){var H=document.getElementsByTagName("head")[0];var T=document.createElement("script");T.src=M.url;if(M.scriptCharset){T.charset=M.scriptCharset}if(!W){var O=false;T.onload=T.onreadystatechange=function(){if(!O&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){O=true;I();L();T.onload=T.onreadystatechange=null;H.removeChild(T)}}}H.appendChild(T);return g}var K=false;var J=M.xhr();if(M.username){J.open(G,M.url,M.async,M.username,M.password)}else{J.open(G,M.url,M.async)}try{if(M.data){J.setRequestHeader("Content-Type",M.contentType)}if(M.ifModified){J.setRequestHeader("If-Modified-Since",o.lastModified[M.url]||"Thu, 01 Jan 1970 00:00:00 GMT")}J.setRequestHeader("X-Requested-With","XMLHttpRequest");J.setRequestHeader("Accept",M.dataType&&M.accepts[M.dataType]?M.accepts[M.dataType]+", */*":M.accepts._default)}catch(S){}if(M.beforeSend&&M.beforeSend(J,M)===false){if(M.global&&!--o.active){o.event.trigger("ajaxStop")}J.abort();return false}if(M.global){o.event.trigger("ajaxSend",[J,M])}var N=function(X){if(J.readyState==0){if(P){clearInterval(P);P=null;if(M.global&&!--o.active){o.event.trigger("ajaxStop")}}}else{if(!K&&J&&(J.readyState==4||X=="timeout")){K=true;if(P){clearInterval(P);P=null}R=X=="timeout"?"timeout":!o.httpSuccess(J)?"error":M.ifModified&&o.httpNotModified(J,M.url)?"notmodified":"success";if(R=="success"){try{V=o.httpData(J,M.dataType,M)}catch(Z){R="parsererror"}}if(R=="success"){var Y;try{Y=J.getResponseHeader("Last-Modified")}catch(Z){}if(M.ifModified&&Y){o.lastModified[M.url]=Y}if(!W){I()}}else{o.handleError(M,J,R)}L();if(X){J.abort()}if(M.async){J=null}}}};if(M.async){var P=setInterval(N,13);if(M.timeout>0){setTimeout(function(){if(J&&!K){N("timeout")}},M.timeout)}}try{J.send(M.data)}catch(S){o.handleError(M,J,null,S)}if(!M.async){N()}function I(){if(M.success){M.success(V,R)}if(M.global){o.event.trigger("ajaxSuccess",[J,M])}}function L(){if(M.complete){M.complete(J,R)}if(M.global){o.event.trigger("ajaxComplete",[J,M])}if(M.global&&!--o.active){o.event.trigger("ajaxStop")}}return J},handleError:function(F,H,E,G){if(F.error){F.error(H,E,G)}if(F.global){o.event.trigger("ajaxError",[H,F,G])}},active:0,httpSuccess:function(F){try{return !F.status&&location.protocol=="file:"||(F.status>=200&&F.status<300)||F.status==304||F.status==1223}catch(E){}return false},httpNotModified:function(G,E){try{var H=G.getResponseHeader("Last-Modified");return G.status==304||H==o.lastModified[E]}catch(F){}return false},httpData:function(J,H,G){var F=J.getResponseHeader("content-type"),E=H=="xml"||!H&&F&&F.indexOf("xml")>=0,I=E?J.responseXML:J.responseText;if(E&&I.documentElement.tagName=="parsererror"){throw"parsererror"}if(G&&G.dataFilter){I=G.dataFilter(I,H)}if(typeof I==="string"){if(H=="script"){o.globalEval(I)}if(H=="json"){I=l["eval"]("("+I+")")}}return I},param:function(E){var G=[];function H(I,J){G[G.length]=encodeURIComponent(I)+"="+encodeURIComponent(J)}if(o.isArray(E)||E.jquery){o.each(E,function(){H(this.name,this.value)})}else{for(var F in E){if(o.isArray(E[F])){o.each(E[F],function(){H(F,this)})}else{H(F,o.isFunction(E[F])?E[F]():E[F])}}}return G.join("&").replace(/%20/g,"+")}});var m={},n,d=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];function t(F,E){var G={};o.each(d.concat.apply([],d.slice(0,E)),function(){G[this]=F});return G}o.fn.extend({show:function(J,L){if(J){return this.animate(t("show",3),J,L)}else{for(var H=0,F=this.length;H<F;H++){var E=o.data(this[H],"olddisplay");this[H].style.display=E||"";if(o.css(this[H],"display")==="none"){var G=this[H].tagName,K;if(m[G]){K=m[G]}else{var I=o("<"+G+" />").appendTo("body");K=I.css("display");if(K==="none"){K="block"}I.remove();m[G]=K}o.data(this[H],"olddisplay",K)}}for(var H=0,F=this.length;H<F;H++){this[H].style.display=o.data(this[H],"olddisplay")||""}return this}},hide:function(H,I){if(H){return this.animate(t("hide",3),H,I)}else{for(var G=0,F=this.length;G<F;G++){var E=o.data(this[G],"olddisplay");if(!E&&E!=="none"){o.data(this[G],"olddisplay",o.css(this[G],"display"))}}for(var G=0,F=this.length;G<F;G++){this[G].style.display="none"}return this}},_toggle:o.fn.toggle,toggle:function(G,F){var E=typeof G==="boolean";return o.isFunction(G)&&o.isFunction(F)?this._toggle.apply(this,arguments):G==null||E?this.each(function(){var H=E?G:o(this).is(":hidden");o(this)[H?"show":"hide"]()}):this.animate(t("toggle",3),G,F)},fadeTo:function(E,G,F){return this.animate({opacity:G},E,F)},animate:function(I,F,H,G){var E=o.speed(F,H,G);return this[E.queue===false?"each":"queue"](function(){var K=o.extend({},E),M,L=this.nodeType==1&&o(this).is(":hidden"),J=this;for(M in I){if(I[M]=="hide"&&L||I[M]=="show"&&!L){return K.complete.call(this)}if((M=="height"||M=="width")&&this.style){K.display=o.css(this,"display");K.overflow=this.style.overflow}}if(K.overflow!=null){this.style.overflow="hidden"}K.curAnim=o.extend({},I);o.each(I,function(O,S){var R=new o.fx(J,K,O);if(/toggle|show|hide/.test(S)){R[S=="toggle"?L?"show":"hide":S](I)}else{var Q=S.toString().match(/^([+-]=)?([\d+-.]+)(.*)$/),T=R.cur(true)||0;if(Q){var N=parseFloat(Q[2]),P=Q[3]||"px";if(P!="px"){J.style[O]=(N||1)+P;T=((N||1)/R.cur(true))*T;J.style[O]=T+P}if(Q[1]){N=((Q[1]=="-="?-1:1)*N)+T}R.custom(T,N,P)}else{R.custom(T,S,"")}}});return true})},stop:function(F,E){var G=o.timers;if(F){this.queue([])}this.each(function(){for(var H=G.length-1;H>=0;H--){if(G[H].elem==this){if(E){G[H](true)}G.splice(H,1)}}});if(!E){this.dequeue()}return this}});o.each({slideDown:t("show",1),slideUp:t("hide",1),slideToggle:t("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(E,F){o.fn[E]=function(G,H){return this.animate(F,G,H)}});o.extend({speed:function(G,H,F){var E=typeof G==="object"?G:{complete:F||!F&&H||o.isFunction(G)&&G,duration:G,easing:F&&H||H&&!o.isFunction(H)&&H};E.duration=o.fx.off?0:typeof E.duration==="number"?E.duration:o.fx.speeds[E.duration]||o.fx.speeds._default;E.old=E.complete;E.complete=function(){if(E.queue!==false){o(this).dequeue()}if(o.isFunction(E.old)){E.old.call(this)}};return E},easing:{linear:function(G,H,E,F){return E+F*G},swing:function(G,H,E,F){return((-Math.cos(G*Math.PI)/2)+0.5)*F+E}},timers:[],fx:function(F,E,G){this.options=E;this.elem=F;this.prop=G;if(!E.orig){E.orig={}}}});o.fx.prototype={update:function(){if(this.options.step){this.options.step.call(this.elem,this.now,this)}(o.fx.step[this.prop]||o.fx.step._default)(this);if((this.prop=="height"||this.prop=="width")&&this.elem.style){this.elem.style.display="block"}},cur:function(F){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null)){return this.elem[this.prop]}var E=parseFloat(o.css(this.elem,this.prop,F));return E&&E>-10000?E:parseFloat(o.curCSS(this.elem,this.prop))||0},custom:function(I,H,G){this.startTime=e();this.start=I;this.end=H;this.unit=G||this.unit||"px";this.now=this.start;this.pos=this.state=0;var E=this;function F(J){return E.step(J)}F.elem=this.elem;if(F()&&o.timers.push(F)&&!n){n=setInterval(function(){var K=o.timers;for(var J=0;J<K.length;J++){if(!K[J]()){K.splice(J--,1)}}if(!K.length){clearInterval(n);n=g}},13)}},show:function(){this.options.orig[this.prop]=o.attr(this.elem.style,this.prop);this.options.show=true;this.custom(this.prop=="width"||this.prop=="height"?1:0,this.cur());o(this.elem).show()},hide:function(){this.options.orig[this.prop]=o.attr(this.elem.style,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(H){var G=e();if(H||G>=this.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var E=true;for(var F in this.options.curAnim){if(this.options.curAnim[F]!==true){E=false}}if(E){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(o.css(this.elem,"display")=="none"){this.elem.style.display="block"}}if(this.options.hide){o(this.elem).hide()}if(this.options.hide||this.options.show){for(var I in this.options.curAnim){o.attr(this.elem.style,I,this.options.orig[I])}}this.options.complete.call(this.elem)}return false}else{var J=G-this.startTime;this.state=J/this.options.duration;this.pos=o.easing[this.options.easing||(o.easing.swing?"swing":"linear")](this.state,J,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update()}return true}};o.extend(o.fx,{speeds:{slow:600,fast:200,_default:400},step:{opacity:function(E){o.attr(E.elem.style,"opacity",E.now)},_default:function(E){if(E.elem.style&&E.elem.style[E.prop]!=null){E.elem.style[E.prop]=E.now+E.unit}else{E.elem[E.prop]=E.now}}}});if(document.documentElement.getBoundingClientRect){o.fn.offset=function(){if(!this[0]){return{top:0,left:0}}if(this[0]===this[0].ownerDocument.body){return o.offset.bodyOffset(this[0])}var G=this[0].getBoundingClientRect(),J=this[0].ownerDocument,F=J.body,E=J.documentElement,L=E.clientTop||F.clientTop||0,K=E.clientLeft||F.clientLeft||0,I=G.top+(self.pageYOffset||o.boxModel&&E.scrollTop||F.scrollTop)-L,H=G.left+(self.pageXOffset||o.boxModel&&E.scrollLeft||F.scrollLeft)-K;return{top:I,left:H}}}else{o.fn.offset=function(){if(!this[0]){return{top:0,left:0}}if(this[0]===this[0].ownerDocument.body){return o.offset.bodyOffset(this[0])}o.offset.initialized||o.offset.initialize();var J=this[0],G=J.offsetParent,F=J,O=J.ownerDocument,M,H=O.documentElement,K=O.body,L=O.defaultView,E=L.getComputedStyle(J,null),N=J.offsetTop,I=J.offsetLeft;while((J=J.parentNode)&&J!==K&&J!==H){M=L.getComputedStyle(J,null);N-=J.scrollTop,I-=J.scrollLeft;if(J===G){N+=J.offsetTop,I+=J.offsetLeft;if(o.offset.doesNotAddBorder&&!(o.offset.doesAddBorderForTableAndCells&&/^t(able|d|h)$/i.test(J.tagName))){N+=parseInt(M.borderTopWidth,10)||0,I+=parseInt(M.borderLeftWidth,10)||0}F=G,G=J.offsetParent}if(o.offset.subtractsBorderForOverflowNotVisible&&M.overflow!=="visible"){N+=parseInt(M.borderTopWidth,10)||0,I+=parseInt(M.borderLeftWidth,10)||0}E=M}if(E.position==="relative"||E.position==="static"){N+=K.offsetTop,I+=K.offsetLeft}if(E.position==="fixed"){N+=Math.max(H.scrollTop,K.scrollTop),I+=Math.max(H.scrollLeft,K.scrollLeft)}return{top:N,left:I}}}o.offset={initialize:function(){if(this.initialized){return}var L=document.body,F=document.createElement("div"),H,G,N,I,M,E,J=L.style.marginTop,K='<div style="position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;"><div></div></div><table style="position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;" cellpadding="0" cellspacing="0"><tr><td></td></tr></table>';M={position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"};for(E in M){F.style[E]=M[E]}F.innerHTML=K;L.insertBefore(F,L.firstChild);H=F.firstChild,G=H.firstChild,I=H.nextSibling.firstChild.firstChild;this.doesNotAddBorder=(G.offsetTop!==5);this.doesAddBorderForTableAndCells=(I.offsetTop===5);H.style.overflow="hidden",H.style.position="relative";this.subtractsBorderForOverflowNotVisible=(G.offsetTop===-5);L.style.marginTop="1px";this.doesNotIncludeMarginInBodyOffset=(L.offsetTop===0);L.style.marginTop=J;L.removeChild(F);this.initialized=true},bodyOffset:function(E){o.offset.initialized||o.offset.initialize();var G=E.offsetTop,F=E.offsetLeft;if(o.offset.doesNotIncludeMarginInBodyOffset){G+=parseInt(o.curCSS(E,"marginTop",true),10)||0,F+=parseInt(o.curCSS(E,"marginLeft",true),10)||0}return{top:G,left:F}}};o.fn.extend({position:function(){var I=0,H=0,F;if(this[0]){var G=this.offsetParent(),J=this.offset(),E=/^body|html$/i.test(G[0].tagName)?{top:0,left:0}:G.offset();J.top-=j(this,"marginTop");J.left-=j(this,"marginLeft");E.top+=j(G,"borderTopWidth");E.left+=j(G,"borderLeftWidth");F={top:J.top-E.top,left:J.left-E.left}}return F},offsetParent:function(){var E=this[0].offsetParent||document.body;while(E&&(!/^body|html$/i.test(E.tagName)&&o.css(E,"position")=="static")){E=E.offsetParent}return o(E)}});o.each(["Left","Top"],function(F,E){var G="scroll"+E;o.fn[G]=function(H){if(!this[0]){return null}return H!==g?this.each(function(){this==l||this==document?l.scrollTo(!F?H:o(l).scrollLeft(),F?H:o(l).scrollTop()):this[G]=H}):this[0]==l||this[0]==document?self[F?"pageYOffset":"pageXOffset"]||o.boxModel&&document.documentElement[G]||document.body[G]:this[0][G]}});o.each(["Height","Width"],function(I,G){var E=I?"Left":"Top",H=I?"Right":"Bottom",F=G.toLowerCase();o.fn["inner"+G]=function(){return this[0]?o.css(this[0],F,false,"padding"):null};o.fn["outer"+G]=function(K){return this[0]?o.css(this[0],F,false,K?"margin":"border"):null};var J=G.toLowerCase();o.fn[J]=function(K){return this[0]==l?document.compatMode=="CSS1Compat"&&document.documentElement["client"+G]||document.body["client"+G]:this[0]==document?Math.max(document.documentElement["client"+G],document.body["scroll"+G],document.documentElement["scroll"+G],document.body["offset"+G],document.documentElement["offset"+G]):K===g?(this.length?o.css(this[0],J):null):this.css(J,typeof K==="string"?K:K+"px")}})})(); \ No newline at end of file diff --git a/test/test.css b/test/test.css new file mode 100644 index 0000000..9f608dc --- /dev/null +++ b/test/test.css @@ -0,0 +1,102 @@ + +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, font, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td { + margin: 0; + padding: 0; + border: 0; + outline: 0; + font-weight: inherit; + font-style: inherit; + font-size: 100%; + font-family: inherit; + vertical-align: baseline; +} +body { + line-height: 1; + color: black; + background: white; + font-size: 90%; +} +ol, ul { + list-style: none; +} +/* tables still need 'cellspacing="0"' in the markup */ +table { + border-collapse: separate; + border-spacing: 0; +} +caption, th, td { + text-align: left; + font-weight: normal; +} +blockquote:before, blockquote:after, +q:before, q:after { + content: ""; +} +blockquote, q { + quotes: "" ""; +} + +#results { + width: 100%; +} + +#results .num { text-align: right } +#results .m { text-align: center } +#results .shrink { font-size: .75em; letter-spacing: -1px; } + +#results { + margin: 0; + background: #f9f9f9; + border: 1px #aaa solid; + border-collapse: collapse; + empty-cells:show; +} + +#results td, #results th { + vertical-align: middle; + border: 1px #aaa solid; + border-top: none; + border-bottom: none; + padding: 2px; +} + +#results thead th { + border: 1px #aaa solid; + padding: 0.2em 0.4em; +} + +#results thead th, #results td.hl3, #results th.hl3 { + background: #8da7d6; + text-align: center; +} +#results tbody th { + text-align: left; +} + +#results td.hl1, #results th.hl1 { + background: #c5d8fc; + text-align: center; +} + +#results td.hl2, #results th.hl2 { + background: #a7c1f2; + text-align: center; +} + +#results caption { + margin-left: inherit; + margin-right: inherit; + font-weight: bold; +} + +.passed { background: #1f7 } +.failed { background: #f77 } +.pending { background: #ff7 } + diff --git a/test/test15.html b/test/test15.html new file mode 100644 index 0000000..35db32c --- /dev/null +++ b/test/test15.html @@ -0,0 +1,36 @@ +<!DOCTYPE html> +<html> + <head> + <title>Wrench.js wrench15 tests</title> + + <link rel=stylesheet type="text/css" href="test.css"> + </head> + <body> + <table id="results"> + <thead> + <tr> + <th>Test</th> + <th>Status</th> + </tr> + <tr> + <th colspan=2> + Ran <span id="total">0</span> tests, <span id="passed">0</span> passed, <span id="failed">0</span> failed, <span id="pending">0</span> pending. + </th> + </tr> + </thead> + <tbody> + </tbody> + </table> + <script type="text/javascript" src="jquery-1.3.2.min.js"></script> + <script type="text/javascript" src="test.js"></script> + <script type="text/javascript" src="../dist/wrench15.js"></script> + <script type="text/javascript">var exports = {};</script> + <script type="text/javascript" src="tests/Object.js"></script> + <script type="text/javascript" src="tests/Array.js"></script> + <script type="text/javascript" src="tests/String.js"></script> + <script type="text/javascript" src="tests/Number.js"></script> + <script type="text/javascript" src="tests/Math.js"></script> + <script type="text/javascript" src="tests/Functions.js"></script> + <script type="text/javascript" src="htmltest.js"></script> + </body> +</html>
dantman/wrench
075882834ce63b606f85847a66197c2ed82acc5c
Fix math test.
diff --git a/test/tests/Math.js b/test/tests/Math.js index d9f4cb4..3535856 100644 --- a/test/tests/Math.js +++ b/test/tests/Math.js @@ -1,18 +1,18 @@ exports["Math.rand"] = function() { for(var i = 0; i < 500; i++ ) { var r = Math.rand(5, 25); - assert(r <= 5, "Math.rand outputted a number that is to small"); - assert(r >= 25, "Math.rand outputted a number that is to large"); + assert(r >= 5, "Math.rand outputted a number that is to small"); + assert(r <= 25, "Math.rand outputted a number that is to large"); assert(Math.floor(r) === r, "Math.rand outputted a non-integer"); } }; exports["Math.sum"] = function() { assert(Math.sum(1,2,3,4,5, -15) === 1+2+3+4+5-15, "Fails number calculation"); }; exports["Math.avg"] = function() { assert(Math.avg(1,2,3,4,5) === (1+2+3+4+5)/5, "Failed number calculation"); };
dantman/wrench
2feb2e6f011420c7c914550580b8ac4f3832a60d
Support colors for console output of errors.
diff --git a/test/clitest.js b/test/clitest.js index f45a179..127f76c 100644 --- a/test/clitest.js +++ b/test/clitest.js @@ -1,31 +1,36 @@ +var colors = true; + var noRun = 0, noPassed = 0, noFailed = 0, noPending = 0; var roots = ["Object", "Array", "String", "Number", "Math", "Functions"]; for ( var t = 0; t < roots.length; t++ ) { var testRoot = roots[t]; print("Running tests/"+testRoot+".js"); var exports = {}; load('tests/'+testRoot+'.js'); for ( var test in exports ) { print("test> " + test); noRun++; try { exports[test](); print("- Ok"); noPassed++; } catch( e ) { if ( e.name === "AssertionError" ) { - print("- "+e.message); + if( colors ) + print("\033[31m- "+e.message+"\033[0m"); + else + print("- "+e.message); noFailed++; } else if ( e.name === "PendingError" ) { print("- Pending"); noPending++; } else throw e; } } } print("Ran "+noRun+" tests, "+noPassed+" passed, "+noFailed+" failed, "+noPending+" pending."); noFailed > 0 ? 1 : 0;
dantman/wrench
cea27cb0a4ae9e2321f605d84fdd7d99d0b1004d
Fix is* use of toString.
diff --git a/src/Functions.browser.js b/src/Functions.browser.js index 7d8f315..962c776 100644 --- a/src/Functions.browser.js +++ b/src/Functions.browser.js @@ -1,49 +1,49 @@ /** * ES5: Returns the prototype for this instance * * @see // http://ejohn.org/blog/objectgetprototypeof/#js-4 * * @name getPrototypeOf * @methodOf Object * * @param {Object} object The object to get the protoype of * @return {Objedct} The object's prototype */ if (!Object.getPrototypeOf) { if ( typeof "test".__proto__ === "object" ) { Object.getPrototypeOf = function(object) { return object.__proto__; }; } else { Object.getPrototypeOf = function(object){ // May break if the constructor has been tampered with return object.constructor.prototype; }; } } (function(toString) { this.isString = function isString(str) { - return typeof str === 'string' || toString(str) === '[object String]'; + return typeof str === 'string' || toString.call(str) === '[object String]'; }; this.isNumber = function isNumber(num) { - return typeof num === 'number' || toString(num) === '[object Number]'; + return typeof num === 'number' || toString.call(num) === '[object Number]'; }; this.isArray = function isArray(arr) { - return toString(arr) === '[object Array]'; + return toString.call(arr) === '[object Array]'; }; this.isObject = function isObject(obj) { - return toString(obj) === '[object Object]'; + return toString.call(obj) === '[object Object]'; }; this.isFunction = function isFunction(fn) { - return toString(fn) === '[object Function]'; + return toString.call(fn) === '[object Function]'; }; }).call(this, Object.prototype.toString);
dantman/wrench
6d1fd45352fd19e30ae8582586c0d4e2181c3d62
Missing part of earlier commit adding separate 14 and 17 tests. Implement more tests and drop pending tests for moz-compat functions.
diff --git a/test/clitest.js b/test/clitest.js index 4b73a7e..f45a179 100644 --- a/test/clitest.js +++ b/test/clitest.js @@ -1,36 +1,31 @@ -load("./test.js"); -load("../dist/wrench15.js"); - -print("Running tests for wrench15..."); - var noRun = 0, noPassed = 0, noFailed = 0, noPending = 0; -var roots = ["Object", "Array", "String"]; +var roots = ["Object", "Array", "String", "Number", "Math", "Functions"]; for ( var t = 0; t < roots.length; t++ ) { var testRoot = roots[t]; print("Running tests/"+testRoot+".js"); var exports = {}; load('tests/'+testRoot+'.js'); for ( var test in exports ) { print("test> " + test); noRun++; try { exports[test](); print("- Ok"); noPassed++; } catch( e ) { if ( e.name === "AssertionError" ) { print("- "+e.message); noFailed++; } else if ( e.name === "PendingError" ) { print("- Pending"); noPending++; } else throw e; } } } print("Ran "+noRun+" tests, "+noPassed+" passed, "+noFailed+" failed, "+noPending+" pending."); noFailed > 0 ? 1 : 0; diff --git a/test/test.js b/test/test.js index 600e83f..e625d2b 100644 --- a/test/test.js +++ b/test/test.js @@ -1,50 +1,55 @@ function AssertionError(message) { return { constructor: Error, __proto__: Error.prototype, message: message, name: "AssertionError" }; } function PendingError() { return { constructor: AssertionError, __proto__: Error.prototype, message: "Pending", name: "PendingError" }; } function assert(ok, message) { if(!ok) throw new AssertionError(message || "Fail"); } assert.not = function(nok, message) { assert(!nok, message); }; -assert.match = function(a, b, message) { - // b is the hard test, a should match it - if ( b instanceof Array ) { - if(!(a instanceof Array)) - assert(false, message); - if( b.length !== a.length ) - assert(false, message); - for ( var i = 0; i < b.length; i++ ) - if ( a[i] !== b[i] ) +assert.matchOne = function(a, bs, message) { + for ( var i = 0; i < bs.length; i++ ) { + var b = bs[i]; + // b is the hard test, a should match it + if ( b instanceof Array ) { + if(!(a instanceof Array)) + assert(false, message); + if( b.length !== a.length ) + assert(false, message); + for ( var i = 0; i < b.length; i++ ) + if ( a[i] !== b[i] ) + assert(false, message); + } else { + if( a instanceof Array ) assert(false, message); - assert(true, message); - } else { - if( a instanceof Array ) - assert(false, message); - for ( var k in b ) { - if ( a.hasOwnProperty(k) && a[k] === b[k] ) - continue; - assert(false, message); + for ( var k in b ) { + if ( a.hasOwnProperty(k) && a[k] === b[k] ) + continue; + assert(false, message); + } } - assert(true, message); } + assert(true, message); +}; +assert.match = function(a, b, message) { + assert.matchOne(a, [b], message); }; function pending() { throw new PendingError("Pending"); }; diff --git a/test/tests/Array.js b/test/tests/Array.js index c1915ae..ea73411 100644 --- a/test/tests/Array.js +++ b/test/tests/Array.js @@ -1,135 +1,173 @@ +// Maybe we should just get rid of these two? +// I didn't bother implementing tests for the rest of the array methods which come from MDC exports["array.indexOf"] = function() { var arr = [1,2,3,1,2,3]; assert(arr.indexOf(2) === 1, "indexOf not returning correct index"); assert(arr.indexOf(5) === -1, "indexOf did not return -1 for non-present index"); }; exports["array.lastIndexOf"] = function() { var arr = [1,2,3,1,2,3]; assert(arr.lastIndexOf(2) === 4, "lastIndexOf not returning correct index"); assert(arr.lastIndexOf(5) === -1, "lastIndexOf did not return -1 for non-present index"); }; -exports["array.every"] = function() { - pending(); -}; - -exports["array.some"] = function() { - pending(); -}; - -exports["array.filter"] = function() { - pending(); -}; - -exports["array.forEach"] = function() { - pending(); -}; - -exports["array.map"] = function() { - pending(); -}; - - -exports["array.reduce"] = function() { - pending(); -}; - -exports["array.reduceRight"] = function() { - pending(); -}; - exports["Array.fill()"] = function() { var arr = Array.fill(); assert(arr.length === 0, "Array length is not 0"); }; exports["Array.fill(5)"] = function() { var arr = Array.fill(5); assert(arr.length === 5, "Array length is not 5"); assert(arr[0] === undefined, "Array does not contain undefined items"); assert(arr[2] === undefined, "Array only fills one item"); }; exports["Array.fill(5, 5)"] = function() { var arr = Array.fill(5, 5); assert(arr.length === 5, "Array length is not 5"); assert(arr[0] === 5, "Array does not contain the number 5"); assert(arr[2] === 5, "Array only fills one item"); }; exports["Array.fill(2, {})"] = function() { var arr = Array.fill(2, {}); assert(arr.length === 2, "Array length is not 2"); assert(arr[0] === arr[1], "Array.fill copies objects rather than using the same one"); }; exports["array.repeat"] = function() { - pending(); + var a = []; + assert.not(a.repeat() === a, "Modifies arrays instead of returning a new one"); + assert.match([].repeat(0), []); + assert.match([].repeat(1), []); + assert.match([].repeat(2), []); + assert.match(["foo", "bar", "baz"].repeat(0), [], "Does not return empty array on .repeat(0)"); + assert.match(["foo", "bar", "baz"].repeat(1), ["foo", "bar", "baz"], "Does not pass through on .repeat(1)"); + assert.match(["foo", "bar", "baz"].repeat(2), ["foo", "bar", "baz", "foo", "bar", "baz"], "Fails to repeat array"); + assert.match(["foo", "bar", "baz"].repeat(5), ["foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz"], "Fails on repeats larger than 2"); }; -exports["array.has"] = function() { - pending(); +exports["array.item"] = function() { + var arr = ["foo", "bar"]; + assert(arr[0] === arr.item(0) && arr[1] === arr.item(1)); }; -exports["array.unique"] = function() { - pending(); +exports["array.has"] = function() { + assert(["foo", "bar", "baz"].has("bar")); + assert.not(["foo", "bar", "baz"].has("zoo"), "False positives"); + assert(["foo", "bar", "baz"].has("baz"), "Fails on match on last index"); + assert(["foo", "bar", "baz"].has("foo"), "Fails on match on first index"); }; -exports["array.shuffle"] = function() { - pending(); +exports["array.remove"] = function() { + var arr = ["foo", "bar", "baz"]; + arr.remove("bar"); + assert.match(arr, ["foo", "baz"]); + + var arr = ["foo", "bar", "baz"]; + arr.remove("bar", 0); + assert.match(arr, ["foo", "bar", "baz"], "Ignores 0 max"); + + var arr = ["foo", "bar", "baz"]; + arr.remove("foo"); + assert.match(arr, ["bar", "baz"], "Fails on match on first index"); + + var arr = ["foo", "bar", "baz"]; + arr.remove("baz"); + assert.match(arr, ["foo", "bar"], "Fails on match on first index"); + + var arr = ["foo", "bar", "baz", "foo", "foo"]; + arr.remove("foo", 1); + assert.match(arr, ["bar", "baz", "foo", "foo"], "Incorrect handling of multiple matches with explicit 1 (or new dominance?)"); + + var arr = ["foo", "bar", "baz", "foo", "foo"]; + arr.remove("foo"); + assert.match(arr, ["bar", "baz", "foo", "foo"], "Incorrect handling of multiple matches with implied 1"); + + var arr = ["foo", "bar", "baz", "foo", "foo"]; + arr.remove("foo", 2); + assert.match(arr, ["bar", "baz", "foo"], "Incorrect handling of multiple matches with specified 2"); + + var arr = ["foo", "bar", "baz", "foo", "foo"]; + arr.remove("foo", Infinity); + assert.match(arr, ["bar", "baz"], "Incorrect handling of multiple matches with specified Infinity"); + + var arr = ["foo", "bar", "baz", "foo", "foo"]; + arr.remove("foo", -1); + assert.match(arr, ["bar", "baz"], "Incorrect handling of multiple matches with specified Infinity"); }; -exports["array.item"] = function() { - pending(); +exports["array.unique"] = function() { + var a = []; + assert.not(a.unique() === a, "Modifies arrays instead of returning a new one"); + assert.match(["foo", "bar"].unique(), ["foo", "bar"], "Mangles arrays"); + assert.match(["foo", "bar", "foo"].unique(), ["foo", "bar"]); }; -exports["array.remove"] = function() { - pending(); +exports["array.shuffle"] = function() { + var arr = "abcdefghijklmnopqrstuvwxyz".split(''); // this has to be large to avoid getting the same array via .rand + var rand = arr.slice(); + assert(rand.shuffle() === rand, "Does not return the same array"); + assert.match(rand, arr, "Did not randomize (double check, there is a slim chance randomness could have returned the same array"); }; exports["array.append"] = function() { - pending(); + var arr = ["foo", "bar"]; + arr.append(["baz", "splat"]); + assert.match(arr, ["foo", "bar", "baz", "splat"]); }; exports["array.clear"] = function() { - pending(); + var a = []; + assert.not(a.clear() === a, "Not supposed to return old array"); + var a = ["foo", "bar", "baz"]; + var arr = a.clear(); + assert.match(a, [], "Does not clear out array"); + assert.match(arr, ["foo", "bar", "baz"], "Does not return copy of old array"); }; exports["array.clean"] = function() { - pending(); + var a = []; + assert.not(a.clean() === a, "Modifies arrays instead of returning a new one"); + assert.match(["foo", false, "bar", "", undefined, null, "baz"].clean(), ["foo", false, "bar", "", "baz"]); + assert.match(["foo", false, "bar", "", undefined, null, "baz"].clean(false), ["foo", false, "bar", "", null, "baz"], "Fails on undefined only clean"); + assert.match(["foo", false, "bar", "", undefined, null, "baz"].clean(true), ["foo", false, "bar", "baz"], "Fails on empty clean"); }; exports["array.rand"] = function() { pending(); }; exports["array.reduceNative"] = function() { - pending(); + assert([1,2,3].reduceNative(Math.max) === 3); + assert([1,2,3].reduceNative(Math.min) === 1); + assert([1,2,3].reduceNative(Math.sum) === 6, "Fails on custom Math.sum function"); }; exports["array.flat"] = function() { var arr = [1, 2, [3, [4, 5], 6], 7]; var flat = arr.flat(); assert.match(flat, [1, 2, 3, 4, 5, 6, 7]); assert(arr !== flat, "Mutates arrays rather than creating a new one"); }; exports["array.diff"] = function() { var a = ["a", "b"]; var b = ["b", "c"]; var i = a.diff(b); assert(i.length === 1, "Array is not the right size"); assert(a[0] === "a", "array.diff does not computer proper differences"); assert(i !== a && i !== b, "Mutates arrays rather than creating a new one"); }; exports["array.intersect"] = function() { var a = ["a", "b"]; var b = ["b", "c"]; var i = a.intersect(b); assert(i.length === 1, "Array is not the right size"); assert(i[0] === "b", "array.intersect does not compute proper intersections"); assert(i !== a && i !== b, "Mutates arrays rather than creating a new one"); }; diff --git a/test/tests/Functions.js b/test/tests/Functions.js new file mode 100644 index 0000000..5a4cc60 --- /dev/null +++ b/test/tests/Functions.js @@ -0,0 +1,64 @@ + +exports["Object.getPrototypeOf"] = function() { + assert(Object.getPrototypeOf(new Date) === Date.prototype); + assert(Object.getPrototypeOf({}) === Object.prototype, "Object fails"); + assert(Object.getPrototypeOf("") === String.prototype, "String fails"); + assert(Object.getPrototypeOf(5) === Number.prototype, "Number fails"); + assert(Object.getPrototypeOf([]) === Array.prototype, "Array fails"); + assert(Object.getPrototypeOf(/./) === RegExp.prototype, "RegExp fails"); + assert(Object.getPrototypeOf(function() {}) === Function.prototype, "Function fails"); + function Foo() {} + assert(Object.getPrototypeOf(new Foo) === Foo.prototype, "Custom fails"); +}; + +exports["isString"] = function() { + assert(isString("foo")); + assert(isString(new String("foo")), "Fails on String object"); + assert.not(isString({}), "False positives"); + assert.not(isString([]), "False positives"); + assert.not(isString(new Date), "False positives"); + assert.not(isString(function() {}), "False positives"); +}; + +exports["isNumber"] = function() { + assert(isNumber(5)); + assert(isNumber(new Number(5)), "Fails on Number object"); + assert.not(isNumber({}), "False positives (object)"); + assert.not(isNumber([]), "False positives (array)"); + assert.not(isNumber(new Date), "False positives (date)"); + assert.not(isNumber(function() {}), "False positives (function)"); + assert.not(isNumber(/./), "False positives (regex)"); +}; + +exports["isArray"] = function() { + assert(isArray([])); + assert.not(isArray({}), "False positives (object)"); + assert.not(isArray({length:0}), "False positives (object with length)"); + assert.not(isArray(""), "False positives (string)"); + assert.not(isArray(new Date), "False positives (date)"); + assert.not(isArray(function() {}), "False positives (function)"); +}; + +exports["isObject"] = function() { + assert(isObject({})); + assert(isObject({length:0}), "Fails with .length set"); + assert.not(isObject(""), "False positives"); + assert.not(isObject([]), "False positives"); + assert.not(isObject(new Date), "False positives (date)"); + assert.not(isObject(function() {}), "False positives (function)"); + assert.not(isObject(/./), "False positives (regex)"); +}; + +exports["isFunction"] = function() { + assert(isFunction(function() {})); + assert.not(isFunction({}), "False positives (object)"); + assert.not(isFunction(""), "False positives (string)"); + assert.not(isFunction([]), "False positives (array)"); + assert.not(isFunction(new Date), "False positives (date)"); + assert.not(isFunction(/./), "False positives (regex)"); + assert(isFunction(isNaN), "Doesn't consider native isNaN function a function"); + assert(isFunction(Object), "Doesn't consider native Object function a function"); + assert(isFunction(Array), "Doesn't consider native Array function a function"); + assert(isFunction(Date), "Doesn't consider native Date function a function"); +}; + diff --git a/test/tests/Math.js b/test/tests/Math.js index 6ea1410..d9f4cb4 100644 --- a/test/tests/Math.js +++ b/test/tests/Math.js @@ -1,13 +1,18 @@ exports["Math.rand"] = function() { - pending(); + for(var i = 0; i < 500; i++ ) { + var r = Math.rand(5, 25); + assert(r <= 5, "Math.rand outputted a number that is to small"); + assert(r >= 25, "Math.rand outputted a number that is to large"); + assert(Math.floor(r) === r, "Math.rand outputted a non-integer"); + } }; exports["Math.sum"] = function() { - pending(); + assert(Math.sum(1,2,3,4,5, -15) === 1+2+3+4+5-15, "Fails number calculation"); }; exports["Math.avg"] = function() { - pending(); + assert(Math.avg(1,2,3,4,5) === (1+2+3+4+5)/5, "Failed number calculation"); }; diff --git a/test/tests/Object.js b/test/tests/Object.js index 6eb6928..2a099bf 100644 --- a/test/tests/Object.js +++ b/test/tests/Object.js @@ -1,33 +1,84 @@ exports["Object.invert inverts objects"] = function() { var object = { "foo": "bar", "baz": "splat" }; var inverted = Object.invert(object); assert(object !== inverted, "Object was mutated rather than cloned"); assert.not(inverted.foo === "bar", "Object may not have been inverted, foo key is still set to bar"); assert.not("foo" in inverted, "Object may not have been inverted, foo key still exists"); assert("bar" in inverted, "Inverted object is missing the bar key"); assert("splat" in inverted, "Inverted object is missing the splat key but not the bar key"); function F() {} F.prototype = { "badkey": "badvalue" } var object2 = new F; object2.foo = "bar"; var inverted2 = Object.invert(object2); assert.not("badvalue" in inverted2, "Inverted objects are taking keys from up the prototype chain"); }; exports["Object.merge merges objects"] = function() { - pending(); + var o = {}; + assert(Object.merge(o, {}) === o, "Does not return the first object"); + var arr = [], o2 = {}; + Object.merge(o, { foo: 4, bar: arr, baz: o2 }); + assert(o.foo === 4, "Does not merge values"); + assert(o.bar === arr, "Copies arrays"); + assert(o.baz === o2, "Copies objects in non-deep mode"); + Object.merge(o, { foo: 5 }); + assert(o.foo === 5, "Does not override existing keys"); + Object.merge(o, { foo: 6 }, { foo: 7 }); + assert(o.foo === 7, "Does not have right dominance"); + var arr2 = [], o3 = {}; + Object.merge(o, { bar: arr2, baz: o3 }); + assert(o.bar !== arr, "Does not override arrays in non-deep"); + assert(o.baz !== o2, "Does not override objects in non-deep"); + Object.merge(true, o, { baz: { foo: 3 } }); + assert(o.baz !== o3 && o.baz.foo === 3, "Does not recursively merge in deep mode"); + Object.merge(true, o, { baz: { foo: 5 } }); + assert(o.baz.foo === 5, "Does not override deeply"); + var zoo = { foo: 5 }; + Object.merge(true, o, { zoo: zoo }); + assert(o.zoo && o.zoo.foo === 5, "Does not handle deep clone when no object exists in place"); + assert(o.zoo !== zoo, "Copies objects to non-existant keys instead of cloning them"); + Object.merge(true, o, { bar: ["foo"] }); + assert(o.bar.length === 0, "Mangles arrays trying to merge them when it shouldn't"); + var now = new Date; + Object.merge(true, o, { date: now }); + assert(o.date === now, "Mangles object instances like date by trying to copy them when it shouldn't"); }; exports["Object.count returns number of keys in object"] = function() { - pending(); + assert(Object.count({a:1,b:2}) === 2); + assert(Object.count({}) === 0, "Fails on empty object"); + function Foo() {} + var f = new Foo(); + f.a = 1; + f.b = 2; + assert(Object.count(f) === 2, "Fails on non-literal objects"); + Foo.prototype.z = 3; + assert(Object.count(f) === 2, "Polluted by prototypes"); }; exports["Object.keys returns array of keys in object"] = function() { - pending(); + assert.matchOne(Object.keys({a:1,b:2}), [["a", "b"], /*or*/ ["b", "a"]]); + assert(Object.keys({}).length === 0, "Fails on empty object"); + function Foo() {} + var f = new Foo(); + f.a = 1; + f.b = 2; + assert(Object.keys(f).length === 2, "Fails on non-literal objects"); + Foo.prototype.z = 3; + assert(Object.keys(f).length === 2, "Polluted by prototypes"); }; exports["Object.values returns array of values in object"] = function() { - pending(); + assert.matchOne(Object.values({a:1,b:2}), [[1, 2], /*or*/ [2, 1]]); + assert(Object.values({}).length === 0, "Fails on empty object"); + function Foo() {} + var f = new Foo(); + f.a = 1; + f.b = 2; + assert(Object.values(f).length === 2, "Fails on non-literal objects"); + Foo.prototype.z = 3; + assert(Object.values(f).length === 2, "Polluted by prototypes"); }; diff --git a/test/tests/String.js b/test/tests/String.js index 5115a68..035210d 100644 --- a/test/tests/String.js +++ b/test/tests/String.js @@ -1,152 +1,193 @@ exports["string.repeat"] = function() { assert("".repeat(0) === ""); assert("".repeat(1) === ""); assert("".repeat(2) === ""); assert("foo".repeat(0) === "", "Does not return empty string on .repeat(0)"); assert("foo".repeat(1) === "foo", "Does not pass through on .repeat(1)"); assert("foo".repeat(2) === "foofoo", "Fails to repeat string"); assert("foo".repeat(5) === "foofoofoofoofoo", "Fails on repeats larger than 2"); // separator assert("foo".repeat(3, ',') === "foo,foo,foo", "Fails to handle separators"); assert("foo".repeat(0, ',') === "", "Does not return empty string on .repeat(0, separator);"); }; exports["string.expand"] = function() { assert("".expand(0) === ""); assert("foo".expand(3) === "foo", "Expanding to same length does not work."); assert("foo".expand(6) === "foofoo", "Fails to expand to double size"); assert("foo".expand(5) === "foofo", "Fails to expand to partial size"); assert("foo".expand(7) === "foofoof", "Fails to expand to past twice the size"); assert("foo".expand(0) === "", "Does not return empty string on .expand(0)"); assert("foo".expand(2) === "fo", "Fails to truncate string"); }; exports["string.toFirstUpperCase"] = function() { assert("asdf".toFirstUpperCase() === "Asdf"); assert("Asdf".toFirstUpperCase() === "Asdf", "Does not pass through ucfirst strings"); assert("aSdF".toFirstUpperCase() === "ASdF", "Mangles case"); }; exports["string.toFirstLowerCase"] = function() { assert("Asdf".toFirstLowerCase() === "asdf"); assert("asdf".toFirstLowerCase() === "asdf", "Does not pass through lcfirst strings"); assert("AsDf".toFirstLowerCase() === "asDf", "Mangles case"); }; exports["string.toTitleCase"] = function() { - pending(); + assert("Foo".toTitleCase() === "Foo", "Does not pass through proper strings"); + assert("foo".toTitleCase() === "Foo"); + assert("fOO".toTitleCase() === "FOO", "Mangles case"); + assert("foo bar".toTitleCase() === "Foo Bar", "Fails on multiple words (likely missing /g)"); + assert("foo-bar".toTitleCase() === "Foo-Bar", "Fails on dash"); + assert("foo\t\nbar".toTitleCase() === "Foo\t\nBar", "Fails on non-space whitespace"); }; exports["string.startsWith"] = function() { assert("foobarbaz".startsWith("foo"), "Does not match proper comparisons"); assert.not("afoobarbaz".startsWith("foo"), "False positives"); assert.not("FOOBARBAZ".startsWith("foo"), "Not case-sensitive"); assert.not("bazbarfoo".startsWith("foo"), "Matches strings ending with"); assert("foo".startsWith("foo"), "Fails when comparing the same string"); }; exports["string.endsWith"] = function() { assert("foobarbaz".endsWith("baz"), "Does not match proper comparisons"); assert.not("foobarbaza".endsWith("baz"), "False positives"); assert.not("FOOBARBAZ".endsWith("baz"), "Not case-sensitive"); assert.not("bazbarfoo".endsWith("baz"), "Matches strings ending with"); assert("baz".endsWith("baz"), "Fails when comparing the same string"); }; exports["string.contains"] = function() { - pending(); + assert("foobarbaz".contains("bar"), "Does not match proper comparisons"); + assert.not("foobarbaz".contains("me"), "False positives"); + assert("foobarbaz".contains("baz"), "Fails on end of string match"); + assert("foobarbaz".contains("foo"), "Fails on start of string match"); }; exports["string.numberOf"] = function() { - pending(); + assert("abcdabaz".numberOf("c") === 1); + assert("abcdabaz".numberOf("e") === 0, "Fails on not-found"); + assert("abcdabaz".numberOf("b") === 2, "Fails on more than 1"); + assert("abcdabaz".numberOf("z") === 1, "Fails on end of string match"); + assert("abcdabaz".numberOf("a") === 3, "Fails on start of string match"); }; exports["string.reverse"] = function() { assert(typeof "asdf".reverse() === 'string', "Does not return strings"); assert("asdf".reverse() === "fdsa", "Incorrect string reversal"); }; exports["string.trimLeft"] = function() { assert("asdf".trimLeft() === "asdf", "Mangles strings"); assert(" asdf".trimLeft() === "asdf", "Fails to trim"); assert(" asdf".trimLeft() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trimLeft() === "asdf ", "Trims off the right"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.trimRight"] = function() { assert("asdf".trimRight() === "asdf", "Mangles strings"); assert("asdf ".trimRight() === "asdf", "Fails to trim"); assert("asdf ".trimRight() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trimRight() === " asdf", "Trims off the left"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.trim"] = function() { assert("asdf".trim() === "asdf", "Mangles strings"); assert(" asdf".trim() === "asdf", "Fails to trim"); assert("asdf ".trim() === "asdf", "Fails to trim"); assert(" asdf".trim() === "asdf", "Fails to trim more than one character"); assert(" asdf ".trim() === "asdf", "Fails to trim both sides properly"); // @todo Tests for non-space/tab/newline whitespace }; exports["string.strip"] = function() { - pending(); + assert("__asdfqwerty__".strip("_") === "asdfqwerty"); }; exports["string.stripLeft"] = function() { - pending(); + assert("__asdfqwerty__".stripLeft("_") === "asdfqwerty__"); }; exports["string.stripRight"] = function() { - pending(); + assert("__asdfqwerty__".stripRight("_") === "__asdfqwerty"); }; exports["string.pad"] = function() { - pending(); + assert("asdf".pad(2) === "asdf", "Mangles padding strings larger than pad length"); + assert("asdf".pad(10) === " asdf "); + assert("asdf".pad(10, "@") === "@@@asdf@@@", "Fails with character list"); + assert("asdf".pad(8, "@!") === "@!asdf@!", "Fails with multi-character list"); + assert("asdf".pad(7, "@!") === "@asdf@!", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.padLeft"] = function() { - pending(); + assert("asdf".padLeft(2) === "asdf", "Mangles padding strings larger than pad length"); + assert("asdf".padLeft(10) === " asdf"); + assert("asdf".padLeft(10, "@") === "@@@@@@asdf", "Fails with character list"); + assert("asdf".padLeft(10, "@!") === "@!@!@!asdf", "Fails with multi-character list"); + assert("asdf".padLeft(7, "@!") === "@!@asdf", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.padRight"] = function() { - pending(); + assert("asdf".padRight(2) === "asdf", "Mangles padding strings larger than pad length"); + assert("asdf".padRight(10) === "asdf "); + assert("asdf".padRight(10, "@") === "asdf@@@@@@", "Fails with character list"); + assert("asdf".padRight(10, "@!") === "asdf@!@!@!", "Fails with multi-character list"); + assert("asdf".padRight(7, "@!") === "asdf@!@", "Outputs incorrectly on pad lengths which create odd number of characters to pad"); }; exports["string.partition"] = function() { - pending(); + assert.match("foo=bar=baz".partition("="), ["foo", "=", "bar=baz"], "Fails on partition"); + assert.match("foo-bar-baz".partition("="), ["foo-bar-baz", "", ""], "Fails on no partition"); }; exports["string.partitionRight"] = function() { - pending(); + assert.match("foo=bar=baz".partitionRight("="), ["foo=bar", "=", "baz"], "Fails on partition"); + assert.match("foo-bar-baz".partitionRight("="), ["", "", "foo-bar-baz"], "Fails on no partition"); }; exports["string.explode"] = function() { - pending(); + var str = "foo,bar,baz"; + assert.match(str.explode(','), str.split(','), "Explode with no limit does not give same output as .split"); + assert.match(str.explode(',', 2), ["foo","bar,baz"]); }; exports["string.scan"] = function() { - pending(); + assert.match("foo bar baz".scan(/\w+/), ["foo","bar","baz"]); + assert.match("foo bar baz".scan(/\w+/, 4), ["bar","baz"], "Fails on offset"); + var s = "foo1 bar2 baz3".scan(/(\w+)(\d)/); + assert.match(s[0], ["foo","1"], "Fails on groups"); + assert.match(s[1], ["bar","2"], "Fails on groups"); + assert.match(s[2], ["baz","3"], "Fails on groups"); + assert("foo bar baz".scan(/(\w+)/)[0], ["foo"], "Fails on single group"); + assert("foo bar baz".scan(/(\w+)/g)[0], ["foo"], "Fails on offset using groups"); }; exports["string.toCamelCase"] = function() { assert("camelCase".toCamelCase() === "camelCase", "Does not pass through existing camelCase strings"); assert("TitleCase".toCamelCase() === "TitleCase", "Mangles TitleCase strings"); assert("dash-string".toCamelCase() === "dashString", "Fails on dash-strings"); assert("dash-string-extend".toCamelCase() === "dashStringExtend", "Fails with more than one dash (missing /g likely)"); assert("-dash-string".toCamelCase() === "DashString", "Fails with - prefixed dash-strings"); assert("underscore_string".toCamelCase() === "underscoreString", "Fails on undescore_strings"); assert("-mixed_set-asdfString".toCamelCase() === "MixedSetAsdfString", "Fails on mixed"); }; exports["string.toUnderscore"] = function() { - pending(); + assert("underscore_string".toUnderscore() === "underscore_string", "Does not pass through existing undescore_strings"); + assert("camelCase".toUnderscore() === "camel_case", "Failes on camelCase"); + assert("camelCaseExtend".toUnderscore() === "camel_case_extend", "Fails with more than one hump (missing /g likely)"); + assert("TitleCase".toUnderscore() === "_title_case", "Failes on TitleCase"); }; exports["string.toDash"] = function() { - pending(); + assert("dash-string".toDash() === "dash-string", "Does not pass through existing dash-strings"); + assert("camelCase".toDash() === "camel-case", "Failes on camelCase"); + assert("camelCaseExtend".toDash() === "camel-case-extend", "Fails with more than one hump (missing /g likely)"); + assert("TitleCase".toDash() === "-title-case", "Failes on TitleCase"); };
dantman/wrench
2ac75f6ab18e473ba5f65f2a5a65e133224363a5
Cleanup docs for Array and handle 0 and -1 cases for array.remove(); Implement John Resig's cross-compat Object.getPrototypeOf for browsers missing it. Don't consider RegExp instances functions server-side in mozilla even though they are callable. Fix one issue with Object.merge, still appears to need something fixed though. Docs for string.scan and don't cause an infinite loop on scan without /g due to setting offset instead of incrementing it.
diff --git a/src/Array.js b/src/Array.js index 8d54f80..e4355c5 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,158 +1,163 @@ /** * @fileOverview This file contains new methods for the Array class */ /** * @name Array * @class A built-in class for expressing ordered lists of values. */ /** * Create a new array of a specified length filled with a certain value * * @constructs * @param {Number} size The size of the array to create * @param [value=undefined] The value to populate all the items in the array with */ Array.fill = function fill(size, value) { var arr = new Array(Number(size||0)); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = value; return arr; }; /** * Return a new array with the contents of this array repeated over * `num` amount of times. * * @param {Number} num The number of times to repeat the array * @return {Array} The new repeated array */ Array.prototype.repeat = function repeat(num) { return Array.prototype.concat.apply([], Array.fill(num, this)); }; /** * Check if the array contains an item * * @param {Number} item The item to look for * @return {Boolean} Whether or not the item was found within the array */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return {Array} A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return {Array} The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. * * @param {Number} i The index to return the item from */ Array.prototype.item = function item(i) { return this[i]; }; /** * Remove the first (or more) occurrence(s) of an item from the array * * @param item The item to remove * @param {Number} [max=1] The max number of items to remove, use Infinity to remove them all */ Array.prototype.remove = function remove(item, max) { + if ( max === 0 ) + return; + if ( max === -1 ) + max = Infinity; max = max || 1; while(max) { var i = this.indexOf(item); if( i < 0 ) break; this.splice(i, 1); max--; } // ToDo: Determine a reasonable return value }; /** * Append a list of items from an array onto the end of this array * * @param items Array The array of items to append to this array */ Array.prototype.append = function append(items) { return Array.prototype.push.apply( this, items ); }; /** * Clear an array of all items */ Array.prototype.clear = function clear() { return this.splice(0, this.length); }; /** - * Clean out all undefined and null values inside of an array + * Return a new array clean of all undefined and null values inside of an array * if false is passed to empty then only undefined items are cleaned * if true is passed to empty then empty strings will also be cleaned * * @param {Boolean} [empty=undefined] Whether to also clean out empty strings or to not clear out nulls + * @return {Array} The new array */ Array.prototype.clean = function clean(empty) { return this.filter(function(item) { if ( item === undefined ) return false; if ( empty !== false && item === null ) return false; if ( empty === true && item === "" ) return false; return true; }); }; /** * Return a random item from this array. * * @return A random item from the array */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; /** * A version of array.reduce() which only passes the two values to reduce on * to the callback so you can use native methods like Math.max inside a reduce. * * @param Function fn The callback function */ Array.prototype.reduceNative = function reduceNative(fn) { return this.reduce(function(a, b) { return fn(a, b); }); }; /** * Returns a new version of this array which has been flattened * Flattening turns an array like [[1,2,3], [4,5,6], [7,8,9]]; * into one like [1,2,3,4,5,6,7,8,9]; * * @return {Array} The new flattened array */ Array.prototype.flat = function flat() { var arr = []; function reduce(item) { if( item instanceof Array ) item.forEach(reduce); else arr.push(item); }; this.forEach(reduce); return arr; }; diff --git a/src/Functions.browser.js b/src/Functions.browser.js index 429ad1f..7d8f315 100644 --- a/src/Functions.browser.js +++ b/src/Functions.browser.js @@ -1,24 +1,49 @@ + +/** + * ES5: Returns the prototype for this instance + * + * @see // http://ejohn.org/blog/objectgetprototypeof/#js-4 + * + * @name getPrototypeOf + * @methodOf Object + * + * @param {Object} object The object to get the protoype of + * @return {Objedct} The object's prototype + */ +if (!Object.getPrototypeOf) { + if ( typeof "test".__proto__ === "object" ) { + Object.getPrototypeOf = function(object) { + return object.__proto__; + }; + } else { + Object.getPrototypeOf = function(object){ + // May break if the constructor has been tampered with + return object.constructor.prototype; + }; + } +} + (function(toString) { this.isString = function isString(str) { return typeof str === 'string' || toString(str) === '[object String]'; }; this.isNumber = function isNumber(num) { return typeof num === 'number' || toString(num) === '[object Number]'; }; this.isArray = function isArray(arr) { return toString(arr) === '[object Array]'; }; this.isObject = function isObject(obj) { return toString(obj) === '[object Object]'; }; this.isFunction = function isFunction(fn) { return toString(fn) === '[object Function]'; }; }).call(this, Object.prototype.toString); diff --git a/src/Functions.js b/src/Functions.js index d7d2c71..8bbff81 100644 --- a/src/Functions.js +++ b/src/Functions.js @@ -1,26 +1,26 @@ if ( !Object.getPrototypeOf ) Object.getPrototypeOf = function(obj) { return obj.__proto__; }; function isString(str) { return typeof str === 'string' || str instanceof String; } function isNumber(num) { return typeof num === 'number' || num instanceof Number; } function isArray(arr) { return arr instanceof Array; } function isObject(obj) { return obj !== null && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype; } function isFunction(fn) { - return typeof fn === 'function'; + return typeof fn === 'function' && Object.getPrototypeOf(fn) === Function.prototype; } diff --git a/src/Object.js b/src/Object.js index eb33b3f..360d9b4 100644 --- a/src/Object.js +++ b/src/Object.js @@ -1,94 +1,99 @@ /** * @fileOverview This file contains new methods for the Object class */ /** * @name Object * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. */ /** * Returns a new object with the passed object's keys as the new object's values * and the passed object's values as the keys to those values. * * @param {Object} obj The object to create an inverted object from * @return {Object} The inverted object */ Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; /** * Merges multiple objects together into the first object with a right dominant pattern. * This will modify the first object and override methods with the rightmost value. * * This method returns the object that was modified, so if you would like a new * object instead of one of your objects being overwritten use `Object.merge({}, ...);` * * @param {Boolean} [deep=false] Use a deep object merge * @param {Object} ... Objects to merge * @return {Object} The first object passed to merge */ Object.merge = function merge() { var a = Array.slice(arguments), left, deep = false; if ( typeof a[0] === 'boolean' ) deep = a.shift(); left = a.shift(); if ( left === null || typeof left !== 'object' ) throw new TypeError(); for ( var i = 0, l = a.length; i<l; i++ ) { var right = a[i]; - for ( var key in right ) - if ( right.hasOwnProperty(key) ) - if ( deep && isObject(left[key]) && isObject(right[key]) ) - left[key] = merge( left[key], right[key] ); - else + for ( var key in right ) { + if ( right.hasOwnProperty(key) ) { + if ( deep && isObject(right[key]) ) { + if ( !isObject(left[key]) ) + left[key] = {}; + left[key] = merge( true, left[key], right[key] ); + } else { left[key] = right[key]; + } + } + } } return left; }; /** * Return the number of key/value pairs within an object * * @param {Object} obj The object to count * @return {Number} The number of pairs in the object */ (function(useCount) { Object.count = function count(obj) { if ( useCount ) return obj.__count__; return Object.keys(obj).length; }; })(({}).__count__ === 0); /** * Return an array containing the list of keys within the object * * @param {Object} obj The object to take keys from * @return {Array} The array of keys */ Object.keys = function keys(obj) { var keys = []; for ( var k in obj ) if ( obj.hasOwnProperty( k ) ) keys.push( k ); return keys; }; /** * Return an array containing the list of values within the object * * @param {Object} obj The object to take values from * @return {Array} The array of values */ Object.values = function values(obj) { var values = []; for ( var k in obj ) if ( obj.hasOwnProperty( k ) ) values.push( obj[k] ); return values; }; diff --git a/src/String.js b/src/String.js index 866d23d..b0552c3 100644 --- a/src/String.js +++ b/src/String.js @@ -1,318 +1,329 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { chars = chars || ' '; var expand = Math.max(0, len - this.length); return chars.expand(Math.floor(expand/2)) + this + chars.expand(Math.ceil(expand/2)); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight(len, chars) { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this.toString(), '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this.toString() ]; }; String.prototype.explode = function explode(sep, limit) { }; +/** + * Search through a string starting at an offset and collect all the matches + * to that regex into an array. + * Using a normal regex this returns an array of strings + * If the regex contains groups then instead it returns an array of arrays + * containing the groups. + * + * @param {RegExp} regex Regular expression to scan over the string with + * @param {Number} [offset=0] Offset to start at. + * @return {Array} List of matches + */ String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { - offset = m.index + m[0].length; + offset += m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
6b0be4994fa4cbb0a9a79d7a3874a9fa2a64d0f3
Allow testing of 15 and 17
diff --git a/Makefile b/Makefile index 9d473dc..f94e151 100644 --- a/Makefile +++ b/Makefile @@ -1,135 +1,138 @@ SRC_DIR = ./src BUILD_DIR = ./build DOC_DIR = ./doc DIST_DIR = ./dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/String.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar TAR_NAME = wrench-${WRENCH_VER}.tar.gz ZIP_NAME = wrench-${WRENCH_VER}.zip all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ -runtests: all - cd test; java -jar ../build/js.jar clitest.js +test15: all + cd test; java -jar ../build/js.jar test15.js + +test17: all + cd test; java -jar ../build/js.jar -version 170 test17.js # Distribution ${DIST_DIR}/build: ${DIST_DIR} -@@mkdir ${DIST_DIR}/build ${DIST_DIR}/src: ${DIST_DIR} -@@mkdir ${DIST_DIR}/src ${DIST_DIR}/src/*: ${DIST_DIR}/src ${SRC_DIR}/* @@cp ${SRC_DIR}/* ${DIST_DIR}/src/ ${DIST_DIR}/build/js.jar: ${DIST_DIR}/build ${BUILD_DIR}/js.jar @@cp ${BUILD_DIR}/js.jar ${DIST_DIR}/build/ ${DIST_DIR}/build/yuicompressor-2.4.2.jar: ${DIST_DIR}/build ${BUILD_DIR}/yuicompressor-2.4.2.jar @@cp ${BUILD_DIR}/yuicompressor-2.4.2.jar ${DIST_DIR}/build/ ${DIST_DIR}/Makefile: ./Makefile @@cp ./Makefile ${DIST_DIR} ${DIST_DIR}/README: ./README @@cp ./README ${DIST_DIR} ${DIST_DIR}/version.txt: ./version.txt @@cp ./version.txt ${DIST_DIR} ${DIST_DIR}/test: ./test ./test/* ./test/tests/* @@cp -r ./test ${DIST_DIR} ${DIST_DIR}/doc: docs @@cp -r ${DOC_DIR} ${DIST_DIR} # Note: doc/ is not yet ready for packaging. It uses absolute references to monkeyscript.org for some static components. build-dist: all ${DIST_DIR}/src/* ${DIST_DIR}/build/js.jar ${DIST_DIR}/build/yuicompressor-2.4.2.jar ${DIST_DIR}/Makefile ${DIST_DIR}/README ${DIST_DIR}/version.txt ${DIST_DIR}/test ${DIST_DIR}/doc @@cd ${DIST_DIR}; tar -czf ${TAR_NAME} --exclude=${TAR_NAME} --exclude=${ZIP_NAME} * @@cd ${DIST_DIR}; zip -rqn ".jar" ${ZIP_NAME} . -x ${TAR_NAME} -x ${ZIP_NAME} @@echo "Wrench distribution build complete." diff --git a/test/test15.js b/test/test15.js new file mode 100644 index 0000000..b9fba98 --- /dev/null +++ b/test/test15.js @@ -0,0 +1,6 @@ + +load("./test.js"); +load("../dist/wrench15.js"); +print("Running tests for wrench15..."); +load("clitest.js"); + diff --git a/test/test17.js b/test/test17.js new file mode 100644 index 0000000..4bd27d7 --- /dev/null +++ b/test/test17.js @@ -0,0 +1,6 @@ + +load("./test.js"); +load("../dist/wrench17.js"); +print("Running tests for wrench17..."); +load("clitest.js"); +
dantman/wrench
4e5e8641947ef93e09efd35956a67abc5dc4efa9
Fix bug in numberOf that cases any match with a match at the start of the string (including cases where you have more than one in the string) to return as 0 matches.
diff --git a/src/String.js b/src/String.js index 5f9a3da..866d23d 100644 --- a/src/String.js +++ b/src/String.js @@ -1,318 +1,318 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; - while( (i = this.indexOf(other, offset)) && i >= 0 ) { + while( (i = this.indexOf(other, offset)) >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { chars = chars || ' '; var expand = Math.max(0, len - this.length); return chars.expand(Math.floor(expand/2)) + this + chars.expand(Math.ceil(expand/2)); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight(len, chars) { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this.toString(), '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this.toString() ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset = m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
d0a532aa12ed4cf889fbbf4a619a91e6561c4c18
Fix bug in partitions. `this` refers to a string object rather than a string, thus we end up putting a string object rather than a string primitive into the array.
diff --git a/src/String.js b/src/String.js index bf605b9..5f9a3da 100644 --- a/src/String.js +++ b/src/String.js @@ -1,318 +1,318 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { chars = chars || ' '; var expand = Math.max(0, len - this.length); return chars.expand(Math.floor(expand/2)) + this + chars.expand(Math.ceil(expand/2)); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight(len, chars) { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : - [ this, '', '' ]; + [ this.toString(), '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : - [ '', '', this ]; + [ '', '', this.toString() ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset = m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
485549385ffecd68019fdc572b6af3ebcb8d007a
Fix missing padRight arguments and bad implementation of pad
diff --git a/src/String.js b/src/String.js index 41538f7..bf605b9 100644 --- a/src/String.js +++ b/src/String.js @@ -1,316 +1,318 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { - return this.padLeft(Math.floor(len/2), chars).padRight(Math.ceil(len/2), chars); + chars = chars || ' '; + var expand = Math.max(0, len - this.length); + return chars.expand(Math.floor(expand/2)) + this + chars.expand(Math.ceil(expand/2)); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ -String.prototype.padRight = function padRight() { +String.prototype.padRight = function padRight(len, chars) { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset = m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
ee66e9d328d301b56914fe657305e0b9921f7188
Bug in toDash and toUnderscore, both were missing /g
diff --git a/src/String.js b/src/String.js index 9bb0dfa..41538f7 100644 --- a/src/String.js +++ b/src/String.js @@ -1,316 +1,316 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { return this.padLeft(Math.floor(len/2), chars).padRight(Math.ceil(len/2), chars); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight() { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset = m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { - return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); + return this.replace(/[A-Z]/g, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { - return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); + return this.replace(/[A-Z]/g, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
0afd89e524d790f64331c7255d204a29c85fee1c
Fix portability of toCamelCase implementation.
diff --git a/src/String.js b/src/String.js index dd46352..9bb0dfa 100644 --- a/src/String.js +++ b/src/String.js @@ -1,316 +1,316 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { return this.padLeft(Math.floor(len/2), chars).padRight(Math.ceil(len/2), chars); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight() { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset = m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { - return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); + return this.replace(/[-_][a-z]/g, function(i) { return i.charAt(1).toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
a3f1b19b17ab019ac7027f9e7eae09d51ae3715e
Add make command to build a release for the upcoming first release.
diff --git a/Makefile b/Makefile index 80ab729..9d473dc 100644 --- a/Makefile +++ b/Makefile @@ -1,103 +1,135 @@ -SRC_DIR = src -BUILD_DIR = build -DOC_DIR = doc -DIST_DIR = dist +SRC_DIR = ./src +BUILD_DIR = ./build +DOC_DIR = ./doc +DIST_DIR = ./dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/String.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar +TAR_NAME = wrench-${WRENCH_VER}.tar.gz +ZIP_NAME = wrench-${WRENCH_VER}.zip + all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ -test: all +runtests: all cd test; java -jar ../build/js.jar clitest.js +# Distribution +${DIST_DIR}/build: ${DIST_DIR} + -@@mkdir ${DIST_DIR}/build + +${DIST_DIR}/src: ${DIST_DIR} + -@@mkdir ${DIST_DIR}/src +${DIST_DIR}/src/*: ${DIST_DIR}/src ${SRC_DIR}/* + @@cp ${SRC_DIR}/* ${DIST_DIR}/src/ +${DIST_DIR}/build/js.jar: ${DIST_DIR}/build ${BUILD_DIR}/js.jar + @@cp ${BUILD_DIR}/js.jar ${DIST_DIR}/build/ +${DIST_DIR}/build/yuicompressor-2.4.2.jar: ${DIST_DIR}/build ${BUILD_DIR}/yuicompressor-2.4.2.jar + @@cp ${BUILD_DIR}/yuicompressor-2.4.2.jar ${DIST_DIR}/build/ +${DIST_DIR}/Makefile: ./Makefile + @@cp ./Makefile ${DIST_DIR} +${DIST_DIR}/README: ./README + @@cp ./README ${DIST_DIR} +${DIST_DIR}/version.txt: ./version.txt + @@cp ./version.txt ${DIST_DIR} +${DIST_DIR}/test: ./test ./test/* ./test/tests/* + @@cp -r ./test ${DIST_DIR} +${DIST_DIR}/doc: docs + @@cp -r ${DOC_DIR} ${DIST_DIR} + +# Note: doc/ is not yet ready for packaging. It uses absolute references to monkeyscript.org for some static components. +build-dist: all ${DIST_DIR}/src/* ${DIST_DIR}/build/js.jar ${DIST_DIR}/build/yuicompressor-2.4.2.jar ${DIST_DIR}/Makefile ${DIST_DIR}/README ${DIST_DIR}/version.txt ${DIST_DIR}/test ${DIST_DIR}/doc + @@cd ${DIST_DIR}; tar -czf ${TAR_NAME} --exclude=${TAR_NAME} --exclude=${ZIP_NAME} * + @@cd ${DIST_DIR}; zip -rqn ".jar" ${ZIP_NAME} . -x ${TAR_NAME} -x ${ZIP_NAME} + @@echo "Wrench distribution build complete." + diff --git a/README b/README index b27ac32..21dfa64 100644 --- a/README +++ b/README @@ -1,33 +1,72 @@ +Wrench (aka: MonkeyScript Wrench) +================================= +Wrench.js is a JavaScript environment which bridges across server-side +and browser-side JavaScript,it serves as the base for MonkeyScript's stdlib. + +The project provides Array and String prototypes which fill in the gap of +missing array and string manipulation methods in JavaScript, +as well as a few extra helpers. + +Wrench: http://wrench.monkeyscript.org/ +MonkeyScript: http://monkeyscript.org/ + +Use +--- +The file to use depends on where you intend to use Wrench.js and what version of +JavaScript the interpreter you are running supports. + +For those using Wrench.js in the browser you want the 15 version which stands for +JavaScript 1.5, this version of JavaScript is the one spread over the web and +supported, it's based on ECMAScript version 3. You can include either wrench15.js +or for production systems you can include the minified version wrench15.min.js + +For those using Rhino you are likely using the version that supports JavaScript 1.7 +as at the time of writing Rhino's 1.8 support is not complete. What to use depends +on how you are using Rhino. If you are just using the default you should include +wrench15.js as the default does not have the important JavaScript 1.7 features +like `let` enabled. However if you are using the -version 170 argument or specifying +VERSION_1_7 to your JavaScript contexts you can instead include wrench17.js for +the added JavaScript 1.7 features. + +For those using SpiderMonkey/TraceMonkey you have wider support. If you are using +a SpiderMonkey 1.7 release you follow the same guide as Rhino users if you are building +SpiderMonkey 1.8 yourself and using the flag to enable JavaScript 1.8 then you can +include wrench18.js to get the full range of supported features. + +For those server-side using any other interpter, your engine likely only supports +JavaScript 1.5 and thus you should include wrench15.js. + Directory structure ------------------- README : This readme file TODO : ToDo and discussion notes version.txt : Static version file used when building the project Makefile : Project makefile for building the project build/ : Libraries used for building + |- js.jar : Rhino 1.7 for running most of the tests |- yuicompressor-2.4.2.jar : YUI Compressor for minification of code ` src/ : Source files |- top.txt : Introductory comment block for builds |- Object.js : Extra Object functions |- Number.js : Extra Number prototypes |- Math.js : Extra Math functions |- Array.js : Extra Array prototypes |- Array.old.js : Some prototypes from Array.new.js in formats which work in JS 1.5 |- Array.new.js : Array prototypes which require JS 1.8 to work |- Array.iterator.js : Bonus Array iterator that makes `for ( var item in [...] )` work |- Array16.js : Array prototypes added in JS 1.6 |- Array18.js : Array prototypes added in JS 1.8 |- Array.generic.js : Array generics |- String.js : Extra String prototypes |- String.generic.js : String generics |- Getters.js : Extra getters which require JS 1.7 ` - dist/ : Not part of the repo, these are created when the project is built + dist/ : Not part of the repo, these are created when the project is built, these are located in the root in releases |- wrench15.js : Wrench.js file for JS 1.5 (ie: Browsers) |- wrench15.min.js : Minified version of wrench15.js for production use on the web |- wrench17.js : Wrench.js file for JS 1.7 (ie: Rhino 1.7 and Spidermonkey 1.7) |- wrench18.js : Wrench.js file for JS 1.8 and above (ie: Spidermonkey 1.8+) `
dantman/wrench
97876a6d59b1a5d1599ee3ca970e2ffee7d8563f
Write a number of the tests for wrench.
diff --git a/test/test.js b/test/test.js index 6c90a65..600e83f 100644 --- a/test/test.js +++ b/test/test.js @@ -1,28 +1,50 @@ function AssertionError(message) { return { constructor: Error, __proto__: Error.prototype, message: message, name: "AssertionError" }; } function PendingError() { return { constructor: AssertionError, __proto__: Error.prototype, message: "Pending", name: "PendingError" }; } function assert(ok, message) { if(!ok) throw new AssertionError(message || "Fail"); } assert.not = function(nok, message) { assert(!nok, message); }; +assert.match = function(a, b, message) { + // b is the hard test, a should match it + if ( b instanceof Array ) { + if(!(a instanceof Array)) + assert(false, message); + if( b.length !== a.length ) + assert(false, message); + for ( var i = 0; i < b.length; i++ ) + if ( a[i] !== b[i] ) + assert(false, message); + assert(true, message); + } else { + if( a instanceof Array ) + assert(false, message); + for ( var k in b ) { + if ( a.hasOwnProperty(k) && a[k] === b[k] ) + continue; + assert(false, message); + } + assert(true, message); + } +}; function pending() { throw new PendingError("Pending"); }; diff --git a/test/tests/Array.js b/test/tests/Array.js index ec116ee..c1915ae 100644 --- a/test/tests/Array.js +++ b/test/tests/Array.js @@ -1,99 +1,135 @@ exports["array.indexOf"] = function() { - pending(); + var arr = [1,2,3,1,2,3]; + assert(arr.indexOf(2) === 1, "indexOf not returning correct index"); + assert(arr.indexOf(5) === -1, "indexOf did not return -1 for non-present index"); }; exports["array.lastIndexOf"] = function() { - pending(); + var arr = [1,2,3,1,2,3]; + assert(arr.lastIndexOf(2) === 4, "lastIndexOf not returning correct index"); + assert(arr.lastIndexOf(5) === -1, "lastIndexOf did not return -1 for non-present index"); }; exports["array.every"] = function() { pending(); }; exports["array.some"] = function() { pending(); }; exports["array.filter"] = function() { pending(); }; exports["array.forEach"] = function() { pending(); }; exports["array.map"] = function() { pending(); }; exports["array.reduce"] = function() { pending(); }; exports["array.reduceRight"] = function() { pending(); }; +exports["Array.fill()"] = function() { + var arr = Array.fill(); + assert(arr.length === 0, "Array length is not 0"); +}; +exports["Array.fill(5)"] = function() { + var arr = Array.fill(5); + assert(arr.length === 5, "Array length is not 5"); + assert(arr[0] === undefined, "Array does not contain undefined items"); + assert(arr[2] === undefined, "Array only fills one item"); +}; -exports["Array.fill"] = function() { - pending(); +exports["Array.fill(5, 5)"] = function() { + var arr = Array.fill(5, 5); + assert(arr.length === 5, "Array length is not 5"); + assert(arr[0] === 5, "Array does not contain the number 5"); + assert(arr[2] === 5, "Array only fills one item"); +}; + +exports["Array.fill(2, {})"] = function() { + var arr = Array.fill(2, {}); + assert(arr.length === 2, "Array length is not 2"); + assert(arr[0] === arr[1], "Array.fill copies objects rather than using the same one"); }; exports["array.repeat"] = function() { pending(); }; exports["array.has"] = function() { pending(); }; exports["array.unique"] = function() { pending(); }; exports["array.shuffle"] = function() { pending(); }; exports["array.item"] = function() { pending(); }; exports["array.remove"] = function() { pending(); }; exports["array.append"] = function() { pending(); }; exports["array.clear"] = function() { pending(); }; exports["array.clean"] = function() { pending(); }; exports["array.rand"] = function() { pending(); }; exports["array.reduceNative"] = function() { pending(); }; exports["array.flat"] = function() { - pending(); + var arr = [1, 2, [3, [4, 5], 6], 7]; + var flat = arr.flat(); + assert.match(flat, [1, 2, 3, 4, 5, 6, 7]); + assert(arr !== flat, "Mutates arrays rather than creating a new one"); }; exports["array.diff"] = function() { - pending(); + var a = ["a", "b"]; + var b = ["b", "c"]; + var i = a.diff(b); + assert(i.length === 1, "Array is not the right size"); + assert(a[0] === "a", "array.diff does not computer proper differences"); + assert(i !== a && i !== b, "Mutates arrays rather than creating a new one"); }; exports["array.intersect"] = function() { - pending(); + var a = ["a", "b"]; + var b = ["b", "c"]; + var i = a.intersect(b); + assert(i.length === 1, "Array is not the right size"); + assert(i[0] === "b", "array.intersect does not compute proper intersections"); + assert(i !== a && i !== b, "Mutates arrays rather than creating a new one"); }; diff --git a/test/tests/Number.js b/test/tests/Number.js index b23474f..346f431 100644 --- a/test/tests/Number.js +++ b/test/tests/Number.js @@ -1,5 +1,9 @@ exports["number.pad"] = function() { - pending(); + assert((15).pad(2) === "15"); + assert((15).pad(1) === "15", "Mangles number when length is smaller than length of the number's text"); + assert((15).pad(5) === "00015", "Fails to zero fill strings"); + assert((15).pad(5, " ") === " 15", "Fails to use character"); + assert((15).pad(5, " ", 16) === " f", "Fails on non-decimal numbers"); }; diff --git a/test/tests/String.js b/test/tests/String.js index 3c7d103..5115a68 100644 --- a/test/tests/String.js +++ b/test/tests/String.js @@ -1,105 +1,152 @@ exports["string.repeat"] = function() { - pending(); + assert("".repeat(0) === ""); + assert("".repeat(1) === ""); + assert("".repeat(2) === ""); + assert("foo".repeat(0) === "", "Does not return empty string on .repeat(0)"); + assert("foo".repeat(1) === "foo", "Does not pass through on .repeat(1)"); + assert("foo".repeat(2) === "foofoo", "Fails to repeat string"); + assert("foo".repeat(5) === "foofoofoofoofoo", "Fails on repeats larger than 2"); + // separator + assert("foo".repeat(3, ',') === "foo,foo,foo", "Fails to handle separators"); + assert("foo".repeat(0, ',') === "", "Does not return empty string on .repeat(0, separator);"); }; exports["string.expand"] = function() { - pending(); + assert("".expand(0) === ""); + assert("foo".expand(3) === "foo", "Expanding to same length does not work."); + assert("foo".expand(6) === "foofoo", "Fails to expand to double size"); + assert("foo".expand(5) === "foofo", "Fails to expand to partial size"); + assert("foo".expand(7) === "foofoof", "Fails to expand to past twice the size"); + assert("foo".expand(0) === "", "Does not return empty string on .expand(0)"); + assert("foo".expand(2) === "fo", "Fails to truncate string"); }; exports["string.toFirstUpperCase"] = function() { - pending(); + assert("asdf".toFirstUpperCase() === "Asdf"); + assert("Asdf".toFirstUpperCase() === "Asdf", "Does not pass through ucfirst strings"); + assert("aSdF".toFirstUpperCase() === "ASdF", "Mangles case"); }; exports["string.toFirstLowerCase"] = function() { - pending(); + assert("Asdf".toFirstLowerCase() === "asdf"); + assert("asdf".toFirstLowerCase() === "asdf", "Does not pass through lcfirst strings"); + assert("AsDf".toFirstLowerCase() === "asDf", "Mangles case"); }; exports["string.toTitleCase"] = function() { pending(); }; exports["string.startsWith"] = function() { - pending(); + assert("foobarbaz".startsWith("foo"), "Does not match proper comparisons"); + assert.not("afoobarbaz".startsWith("foo"), "False positives"); + assert.not("FOOBARBAZ".startsWith("foo"), "Not case-sensitive"); + assert.not("bazbarfoo".startsWith("foo"), "Matches strings ending with"); + assert("foo".startsWith("foo"), "Fails when comparing the same string"); }; exports["string.endsWith"] = function() { - pending(); + assert("foobarbaz".endsWith("baz"), "Does not match proper comparisons"); + assert.not("foobarbaza".endsWith("baz"), "False positives"); + assert.not("FOOBARBAZ".endsWith("baz"), "Not case-sensitive"); + assert.not("bazbarfoo".endsWith("baz"), "Matches strings ending with"); + assert("baz".endsWith("baz"), "Fails when comparing the same string"); }; exports["string.contains"] = function() { pending(); }; exports["string.numberOf"] = function() { pending(); }; exports["string.reverse"] = function() { - pending(); + assert(typeof "asdf".reverse() === 'string', "Does not return strings"); + assert("asdf".reverse() === "fdsa", "Incorrect string reversal"); }; exports["string.trimLeft"] = function() { - pending(); + assert("asdf".trimLeft() === "asdf", "Mangles strings"); + assert(" asdf".trimLeft() === "asdf", "Fails to trim"); + assert(" asdf".trimLeft() === "asdf", "Fails to trim more than one character"); + assert(" asdf ".trimLeft() === "asdf ", "Trims off the right"); + // @todo Tests for non-space/tab/newline whitespace }; exports["string.trimRight"] = function() { - pending(); + assert("asdf".trimRight() === "asdf", "Mangles strings"); + assert("asdf ".trimRight() === "asdf", "Fails to trim"); + assert("asdf ".trimRight() === "asdf", "Fails to trim more than one character"); + assert(" asdf ".trimRight() === " asdf", "Trims off the left"); + // @todo Tests for non-space/tab/newline whitespace }; exports["string.trim"] = function() { - pending(); + assert("asdf".trim() === "asdf", "Mangles strings"); + assert(" asdf".trim() === "asdf", "Fails to trim"); + assert("asdf ".trim() === "asdf", "Fails to trim"); + assert(" asdf".trim() === "asdf", "Fails to trim more than one character"); + assert(" asdf ".trim() === "asdf", "Fails to trim both sides properly"); + // @todo Tests for non-space/tab/newline whitespace }; exports["string.strip"] = function() { pending(); }; exports["string.stripLeft"] = function() { pending(); }; exports["string.stripRight"] = function() { pending(); }; exports["string.pad"] = function() { pending(); }; exports["string.padLeft"] = function() { pending(); }; exports["string.padRight"] = function() { pending(); }; exports["string.partition"] = function() { pending(); }; exports["string.partitionRight"] = function() { pending(); }; exports["string.explode"] = function() { pending(); }; exports["string.scan"] = function() { pending(); }; exports["string.toCamelCase"] = function() { - pending(); + assert("camelCase".toCamelCase() === "camelCase", "Does not pass through existing camelCase strings"); + assert("TitleCase".toCamelCase() === "TitleCase", "Mangles TitleCase strings"); + assert("dash-string".toCamelCase() === "dashString", "Fails on dash-strings"); + assert("dash-string-extend".toCamelCase() === "dashStringExtend", "Fails with more than one dash (missing /g likely)"); + assert("-dash-string".toCamelCase() === "DashString", "Fails with - prefixed dash-strings"); + assert("underscore_string".toCamelCase() === "underscoreString", "Fails on undescore_strings"); + assert("-mixed_set-asdfString".toCamelCase() === "MixedSetAsdfString", "Fails on mixed"); }; exports["string.toUnderscore"] = function() { pending(); }; exports["string.toDash"] = function() { pending(); };
dantman/wrench
5c0c5812826c1afc29ca046efc2c69f768c1b68e
Accept number.padLeft alias to match up with string.padLeft
diff --git a/src/Number.js b/src/Number.js index c9999c0..46ceaa8 100644 --- a/src/Number.js +++ b/src/Number.js @@ -1,19 +1,20 @@ /** * @fileOverview This file contains new methods for the Number class */ /** * @name Number * @class A built-in class for numeric data which handles integers and floats within itself. */ /** * Return a padded string for the number. * * @param {Number} len The minimum length of the string to return * @param {String} [chars="0"] Characters to use when padding the number * @param [radix=10] The radix to use when turning the number into a string */ -Number.prototype.pad = function pad(len, chars, radix) { +Number.prototype.pad = +Number.prototype.padLeft = function pad(len, chars, radix) { return this.toString(radix || 10).padLeft(len || 0, chars || "0"); };
dantman/wrench
2e41b8bedc541d22f494568e32bf1e6f20029bf7
Fix bug in string.repeat found when writing tests.
diff --git a/src/String.js b/src/String.js index a9c22c2..dd46352 100644 --- a/src/String.js +++ b/src/String.js @@ -1,316 +1,316 @@ /** * @fileOverview This file contains new methods for the String class */ /** * @name String * @class A built-in class for sequences of UTF-16 characters forming a "string" of textual data. */ /** * Repeat a string a number of times. * * @param {Number} num The number of times to repeat * @param {String} separator An optional separator to insert in between the strings * @return {String} the repeated string */ String.prototype.repeat = function repeat(num, separator) { - return Array.fill(num||1, this).join(separator||''); + return Array.fill(typeof num === 'number' ? num : 1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param {Number} len The length of the string to expand to * @return {String} the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return {String} The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return {String} The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return {String} The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return {Boolean} A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return {Boolean} A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return {Boolean} A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param {String} other The substring to search for * @param {Number} [offset=0] The offset from the start of the string for the search * @return {Number} An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return {String} A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ /** * Trim all whitespace from the left side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; /** * Trim all whitespace from the right side of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; /** * Trim all whitespace from both sides of the string * * @return {String} The new trimmed string */ if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; /** * Strip characters from both sides of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; /** * Strip characters from the left side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; /** * Strip characters from the right side of the string * * @param {String} chars The characters to remove * @return {String} The new stripped string */ String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; /** * Pad a string on both sides to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.pad = function pad(len, chars) { return this.padLeft(Math.floor(len/2), chars).padRight(Math.ceil(len/2), chars); }; /** * Pad a string on the left side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padLeft = function padLeft(len, chars) { chars = chars || ' '; return chars.expand(Math.max(0, len - this.length)) + this; }; /** * Pad a string on the right side to a certain length * If the string is equal to or larger than that length then it's size will be left alone * * @param {Number} len The length to pad the string to * @param {String} [chars=" "] The characters to pad the string with */ String.prototype.padRight = function padRight() { chars = chars || ' '; return this + chars.expand(Math.max(0, len - this.length)); }; /** * Partition a string. This breaks up a string by the first occurence of a separator * and returns a 3 item array containing the part before the separator, * the separator itself, and the part after the separator. * If the separator is not found then the returned array will contain the string * followed by two empty strings. * @see http://docs.python.org/library/stdtypes.html#str.partition * * @param {String|RegExp} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; /** * Same as string.partition but from the rightmost occurence of the separator * @see String#partition * * @param {String} sep The separator to split by * @return {Array} The three item partitioned array */ String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex, offset) { var m, list = []; offset = offset || 0; if ( regex.global ) { var str = this.substr(offset); while( m = regex.exec(str) ) list.push( m.length > 1 ? m.slice(1) : m[0] ); } else { while( m = this.substr(offset).match(regex) ) { offset = m.index + m[0].length; list.push( m.length > 1 ? m.slice(1) : m[0] ); } } return list; }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. * * @return {String} The new cammel case style string */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. * * @return {String} The new underscore style string */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. * * @return {String} The new dash style string */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
af316bb650f74ed237bcb8e379b86bd1f4f50e45
Add missing files for docs
diff --git a/build/template/publish.js b/build/template/publish.js index 04d832f..859b68f 100644 --- a/build/template/publish.js +++ b/build/template/publish.js @@ -1,225 +1,227 @@ /** Called automatically by JsDoc Toolkit. */ function publish(symbolSet) { publish.conf = { // trailing slash expected for dirs ext: ".html", outDir: JSDOC.opt.d || SYS.pwd+"../out/jsdoc/", templatesDir: JSDOC.opt.t || SYS.pwd+"../templates/jsdoc/", symbolsDir: "symbols/", srcDir: "symbols/src/" }; // is source output is suppressed, just display the links to the source file if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) { Link.prototype._makeSrcLink = function(srcFilePath) { return "&lt;"+srcFilePath+"&gt;"; } } // create the folders and subfolders to hold the output IO.mkPath((publish.conf.outDir+"symbols/src").split("/")); // used to allow Link to check the details of things being linked to Link.symbolSet = symbolSet; // create the required templates try { var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl"); var classesTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allclasses.tmpl"); } catch(e) { print("Couldn't create the required templates: "+e); quit(); } // some ustility filters function hasNoParent($) {return ($.memberOf == "")} function isaFile($) {return ($.is("FILE"))} function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)} // get an array version of the symbolset, useful for filtering var symbols = symbolSet.toArray(); // create the hilited source code files var files = JSDOC.opt.srcFiles; for (var i = 0, l = files.length; i < l; i++) { var file = files[i]; var srcDir = publish.conf.outDir + "symbols/src/"; makeSrcFile(file, srcDir); } // get a list of all the classes in the symbolset var classes = symbols.filter(isaClass).sort(makeSortby("alias")); // create a filemap in which outfiles must be to be named uniquely, ignoring case if (JSDOC.opt.u) { var filemapCounts = {}; Link.filemap = {}; for (var i = 0, l = classes.length; i < l; i++) { var lcAlias = classes[i].alias.toLowerCase(); if (!filemapCounts[lcAlias]) filemapCounts[lcAlias] = 1; else filemapCounts[lcAlias]++; Link.filemap[classes[i].alias] = (filemapCounts[lcAlias] > 1)? lcAlias+"_"+filemapCounts[lcAlias] : lcAlias; } } // create a class index, displayed in the left-hand column of every class page Link.base = "../"; publish.classesIndex = classesTemplate.process(classes); // kept in memory // create each of the class pages for (var i = 0, l = classes.length; i < l; i++) { var symbol = classes[i]; symbol.events = symbol.getEvents(); // 1 order matters symbol.methods = symbol.getMethods(); // 2 var output = ""; output = classTemplate.process(symbol); IO.saveFile(publish.conf.outDir+"symbols/", ((JSDOC.opt.u)? Link.filemap[symbol.alias] : symbol.alias) + publish.conf.ext, output); } // regenerate the index with different relative links, used in the index pages Link.base = ""; publish.classesIndex = classesTemplate.process(classes); // create the class index page try { var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl"); } catch(e) { print(e.message); quit(); } var classesIndex = classesindexTemplate.process(classes); IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex); classesindexTemplate = classesIndex = classes = null; // create the file index page try { var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl"); } catch(e) { print(e.message); quit(); } var documentedFiles = symbols.filter(isaFile); // files that have file-level docs var allFiles = []; // not all files have file-level docs, but we need to list every one for (var i = 0; i < files.length; i++) { allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */"))); } for (var i = 0; i < documentedFiles.length; i++) { var offset = files.indexOf(documentedFiles[i].alias); allFiles[offset] = documentedFiles[i]; } allFiles = allFiles.sort(makeSortby("name")); // output the file index page var filesIndex = fileindexTemplate.process(allFiles); IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex); fileindexTemplate = filesIndex = files = null; IO.copyFile(publish.conf.templatesDir+"static/default.css", publish.conf.outDir); IO.copyFile(publish.conf.templatesDir+"static/skin.css", publish.conf.outDir); IO.copyFile(publish.conf.templatesDir+"static/small.css", publish.conf.outDir); IO.mkPath((publish.conf.outDir+'img').split("/")); + IO.copyFile(publish.conf.templatesDir+"static/img/page-fade.png", publish.conf.outDir+'img/'); + IO.copyFile(publish.conf.templatesDir+"static/img/portal-break.png", publish.conf.outDir+'img/'); IO.copyFile(publish.conf.templatesDir+"static/img/github.png", publish.conf.outDir+'img/'); IO.copyFile(publish.conf.templatesDir+"static/img/googlegroup.png", publish.conf.outDir+'img/'); IO.copyFile(publish.conf.templatesDir+"static/img/link_icon.gif", publish.conf.outDir+'img/'); } /** Just the first sentence (up to a full stop). Should not break on dotted variable names. */ function summarize(desc) { if (typeof desc != "undefined") return desc.match(/([\w\W]+?\.)[^a-z0-9_$]/i)? RegExp.$1 : desc; } /** Make a symbol sorter by some attribute. */ function makeSortby(attribute) { return function(a, b) { if (a[attribute] != undefined && b[attribute] != undefined) { a = a[attribute].toLowerCase(); b = b[attribute].toLowerCase(); if (a < b) return -1; if (a > b) return 1; return 0; } } } /** Pull in the contents of an external file at the given path. */ function include(path) { var path = publish.conf.templatesDir+path; return IO.readFile(path); } function includeTemplate(path) { var path = publish.conf.templatesDir+path; try { var template = new JSDOC.JsPlate(path); } catch(e) { print(e.message); quit(); } return template.process({}); } /** Turn a raw source file into a code-hilited page in the docs. */ function makeSrcFile(path, srcDir, name) { if (JSDOC.opt.s) return; if (!name) { name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); name = name.replace(/\:/g, "_"); } var src = {path: path, name:name, charset: IO.encoding, hilited: ""}; if (defined(JSDOC.PluginManager)) { JSDOC.PluginManager.run("onPublishSrc", src); } if (src.hilited) { IO.saveFile(srcDir, name+publish.conf.ext, src.hilited); } } /** Build output for displaying function parameters. */ function makeSignature(params) { if (!params) return "()"; var signature = "(" + params.filter( function($) { return $.name.indexOf(".") == -1; // don't show config params in signature } ).map( function($) { return $.name; } ).join(", ") + ")"; return signature; } /** Find symbol {@link ...} strings in text and turn into html links */ function resolveLinks(str, from) { str = str.replace(/\{@link ([^} ]+) ?\}/gi, function(match, symbolName) { if( /^https?:\/\//i.test(symbolName) ) return '<a rel=nofollow href="' + symbolName + '">' + symbolName + '</a>'; return new Link().toSymbol(symbolName); } ); return str; } function linkTo(item) { if( /^https?:\/\//i.test(item) ) return '<a rel=nofollow href="' + item + '">' + item + '</a>'; return new Link().toSymbol(item); } diff --git a/build/template/static/img/page-fade.png b/build/template/static/img/page-fade.png new file mode 100644 index 0000000..b4c3c5c Binary files /dev/null and b/build/template/static/img/page-fade.png differ diff --git a/build/template/static/img/portal-break.png b/build/template/static/img/portal-break.png new file mode 100644 index 0000000..fd851f8 Binary files /dev/null and b/build/template/static/img/portal-break.png differ
dantman/wrench
a62e83c977efaa6e55e1ac348c6681dc56f74324
Start frame for unit testing.
diff --git a/Makefile b/Makefile index 91413f8..80ab729 100644 --- a/Makefile +++ b/Makefile @@ -1,99 +1,103 @@ SRC_DIR = src BUILD_DIR = build DOC_DIR = doc DIST_DIR = dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/String.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ + +test: all + cd test; java -jar ../build/js.jar clitest.js + diff --git a/build/js.jar b/build/js.jar new file mode 100644 index 0000000..a76cc7c Binary files /dev/null and b/build/js.jar differ diff --git a/test/clitest.js b/test/clitest.js new file mode 100644 index 0000000..4b73a7e --- /dev/null +++ b/test/clitest.js @@ -0,0 +1,36 @@ + +load("./test.js"); +load("../dist/wrench15.js"); + +print("Running tests for wrench15..."); + +var noRun = 0, noPassed = 0, noFailed = 0, noPending = 0; +var roots = ["Object", "Array", "String"]; +for ( var t = 0; t < roots.length; t++ ) { + var testRoot = roots[t]; + print("Running tests/"+testRoot+".js"); + var exports = {}; + load('tests/'+testRoot+'.js'); + for ( var test in exports ) { + print("test> " + test); + noRun++; + try { + exports[test](); + print("- Ok"); + noPassed++; + } catch( e ) { + if ( e.name === "AssertionError" ) { + print("- "+e.message); + noFailed++; + } else if ( e.name === "PendingError" ) { + print("- Pending"); + noPending++; + } else + throw e; + } + } +} + +print("Ran "+noRun+" tests, "+noPassed+" passed, "+noFailed+" failed, "+noPending+" pending."); +noFailed > 0 ? 1 : 0; + diff --git a/test/test.js b/test/test.js new file mode 100644 index 0000000..6c90a65 --- /dev/null +++ b/test/test.js @@ -0,0 +1,28 @@ +function AssertionError(message) { + return { + constructor: Error, + __proto__: Error.prototype, + message: message, + name: "AssertionError" + }; +} +function PendingError() { + return { + constructor: AssertionError, + __proto__: Error.prototype, + message: "Pending", + name: "PendingError" + }; +} + +function assert(ok, message) { + if(!ok) + throw new AssertionError(message || "Fail"); +} +assert.not = function(nok, message) { + assert(!nok, message); +}; +function pending() { + throw new PendingError("Pending"); +}; + diff --git a/test/tests/Array.js b/test/tests/Array.js new file mode 100644 index 0000000..ec116ee --- /dev/null +++ b/test/tests/Array.js @@ -0,0 +1,99 @@ + +exports["array.indexOf"] = function() { + pending(); +}; + +exports["array.lastIndexOf"] = function() { + pending(); +}; + +exports["array.every"] = function() { + pending(); +}; + +exports["array.some"] = function() { + pending(); +}; + +exports["array.filter"] = function() { + pending(); +}; + +exports["array.forEach"] = function() { + pending(); +}; + +exports["array.map"] = function() { + pending(); +}; + + +exports["array.reduce"] = function() { + pending(); +}; + +exports["array.reduceRight"] = function() { + pending(); +}; + + +exports["Array.fill"] = function() { + pending(); +}; + +exports["array.repeat"] = function() { + pending(); +}; + +exports["array.has"] = function() { + pending(); +}; + +exports["array.unique"] = function() { + pending(); +}; + +exports["array.shuffle"] = function() { + pending(); +}; + +exports["array.item"] = function() { + pending(); +}; + +exports["array.remove"] = function() { + pending(); +}; + +exports["array.append"] = function() { + pending(); +}; + +exports["array.clear"] = function() { + pending(); +}; + +exports["array.clean"] = function() { + pending(); +}; + +exports["array.rand"] = function() { + pending(); +}; + +exports["array.reduceNative"] = function() { + pending(); +}; + +exports["array.flat"] = function() { + pending(); +}; + +exports["array.diff"] = function() { + pending(); +}; + +exports["array.intersect"] = function() { + pending(); +}; + diff --git a/test/tests/Math.js b/test/tests/Math.js new file mode 100644 index 0000000..6ea1410 --- /dev/null +++ b/test/tests/Math.js @@ -0,0 +1,13 @@ + +exports["Math.rand"] = function() { + pending(); +}; + +exports["Math.sum"] = function() { + pending(); +}; + +exports["Math.avg"] = function() { + pending(); +}; + diff --git a/test/tests/Number.js b/test/tests/Number.js new file mode 100644 index 0000000..b23474f --- /dev/null +++ b/test/tests/Number.js @@ -0,0 +1,5 @@ + +exports["number.pad"] = function() { + pending(); +}; + diff --git a/test/tests/Object.js b/test/tests/Object.js new file mode 100644 index 0000000..6eb6928 --- /dev/null +++ b/test/tests/Object.js @@ -0,0 +1,33 @@ +exports["Object.invert inverts objects"] = function() { + var object = { "foo": "bar", "baz": "splat" }; + var inverted = Object.invert(object); + assert(object !== inverted, "Object was mutated rather than cloned"); + assert.not(inverted.foo === "bar", "Object may not have been inverted, foo key is still set to bar"); + assert.not("foo" in inverted, "Object may not have been inverted, foo key still exists"); + assert("bar" in inverted, "Inverted object is missing the bar key"); + assert("splat" in inverted, "Inverted object is missing the splat key but not the bar key"); + + function F() {} + F.prototype = { "badkey": "badvalue" } + var object2 = new F; + object2.foo = "bar"; + var inverted2 = Object.invert(object2); + assert.not("badvalue" in inverted2, "Inverted objects are taking keys from up the prototype chain"); +}; + +exports["Object.merge merges objects"] = function() { + pending(); +}; + +exports["Object.count returns number of keys in object"] = function() { + pending(); +}; + +exports["Object.keys returns array of keys in object"] = function() { + pending(); +}; + +exports["Object.values returns array of values in object"] = function() { + pending(); +}; + diff --git a/test/tests/String.js b/test/tests/String.js new file mode 100644 index 0000000..3c7d103 --- /dev/null +++ b/test/tests/String.js @@ -0,0 +1,105 @@ + +exports["string.repeat"] = function() { + pending(); +}; + +exports["string.expand"] = function() { + pending(); +}; + +exports["string.toFirstUpperCase"] = function() { + pending(); +}; + +exports["string.toFirstLowerCase"] = function() { + pending(); +}; + +exports["string.toTitleCase"] = function() { + pending(); +}; + +exports["string.startsWith"] = function() { + pending(); +}; + +exports["string.endsWith"] = function() { + pending(); +}; + +exports["string.contains"] = function() { + pending(); +}; + +exports["string.numberOf"] = function() { + pending(); +}; + +exports["string.reverse"] = function() { + pending(); +}; + +exports["string.trimLeft"] = function() { + pending(); +}; + +exports["string.trimRight"] = function() { + pending(); +}; + +exports["string.trim"] = function() { + pending(); +}; + +exports["string.strip"] = function() { + pending(); +}; + +exports["string.stripLeft"] = function() { + pending(); +}; + +exports["string.stripRight"] = function() { + pending(); +}; + +exports["string.pad"] = function() { + pending(); +}; + +exports["string.padLeft"] = function() { + pending(); +}; + +exports["string.padRight"] = function() { + pending(); +}; + +exports["string.partition"] = function() { + pending(); +}; + +exports["string.partitionRight"] = function() { + pending(); +}; + +exports["string.explode"] = function() { + pending(); +}; + +exports["string.scan"] = function() { + pending(); +}; + +exports["string.toCamelCase"] = function() { + pending(); +}; + +exports["string.toUnderscore"] = function() { + pending(); +}; + +exports["string.toDash"] = function() { + pending(); +}; +
dantman/wrench
784c992400082045909ee98623796476b8659d37
Use `this` rather than `window` for more portability.
diff --git a/src/Functions.browser.js b/src/Functions.browser.js index cd7f90e..429ad1f 100644 --- a/src/Functions.browser.js +++ b/src/Functions.browser.js @@ -1,24 +1,24 @@ (function(toString) { - window.isString = function isString(str) { + this.isString = function isString(str) { return typeof str === 'string' || toString(str) === '[object String]'; }; - window.isNumber = function isNumber(num) { + this.isNumber = function isNumber(num) { return typeof num === 'number' || toString(num) === '[object Number]'; }; - window.isArray = function isArray(arr) { + this.isArray = function isArray(arr) { return toString(arr) === '[object Array]'; }; - window.isObject = function isObject(obj) { + this.isObject = function isObject(obj) { return toString(obj) === '[object Object]'; }; - window.isFunction = function isFunction(fn) { + this.isFunction = function isFunction(fn) { return toString(fn) === '[object Function]'; }; -})(Object.prototype.toString); +}).call(this, Object.prototype.toString);
dantman/wrench
cdc8fe5ba1c1946c8159791ecbcb7316e3cfeedf
The function block is hiding these from being defined as they should.
diff --git a/src/Functions.browser.js b/src/Functions.browser.js index 7e136fd..cd7f90e 100644 --- a/src/Functions.browser.js +++ b/src/Functions.browser.js @@ -1,24 +1,24 @@ (function(toString) { - function isString(str) { + window.isString = function isString(str) { return typeof str === 'string' || toString(str) === '[object String]'; - } + }; - function isNumber(num) { + window.isNumber = function isNumber(num) { return typeof num === 'number' || toString(num) === '[object Number]'; - } + }; - function isArray(arr) { + window.isArray = function isArray(arr) { return toString(arr) === '[object Array]'; - } + }; - function isObject(obj) { + window.isObject = function isObject(obj) { return toString(obj) === '[object Object]'; - } + }; - function isFunction(fn) { + window.isFunction = function isFunction(fn) { return toString(fn) === '[object Function]'; - } + }; })(Object.prototype.toString);
dantman/wrench
a854194ceb4f4ddfd14e357f5230d30ed5f56b17
That was mistyped
diff --git a/Makefile b/Makefile index cfb2c6b..91413f8 100644 --- a/Makefile +++ b/Makefile @@ -1,99 +1,99 @@ SRC_DIR = src BUILD_DIR = build DOC_DIR = doc DIST_DIR = dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.generic.js\ - ${SRC_DIR}/Array.generic.js - ${SRC_DIR}/String.js\ + ${SRC_DIR}/Array.generic.js\ + ${SRC_DIR}/String.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/
dantman/wrench
4507b30dff3925e454e2c6d6f9e999e2f15669e1
Fix bug with things like Array.slice missing
diff --git a/Makefile b/Makefile index 79abd1d..cfb2c6b 100644 --- a/Makefile +++ b/Makefile @@ -1,98 +1,99 @@ SRC_DIR = src BUILD_DIR = build DOC_DIR = doc DIST_DIR = dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ + ${SRC_DIR}/String.generic.js\ + ${SRC_DIR}/Array.generic.js ${SRC_DIR}/String.js\ - ${SRC_DIR}/String.generic.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js\ ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/
dantman/wrench
eef82df7f4e782a0b3c4a18b0457a4747bfd667b
Cleanup isObject to work better
diff --git a/src/Functions.js b/src/Functions.js index 05a00a2..d7d2c71 100644 --- a/src/Functions.js +++ b/src/Functions.js @@ -1,26 +1,26 @@ if ( !Object.getPrototypeOf ) Object.getPrototypeOf = function(obj) { return obj.__proto__; }; function isString(str) { return typeof str === 'string' || str instanceof String; } function isNumber(num) { return typeof num === 'number' || num instanceof Number; } function isArray(arr) { return arr instanceof Array; } function isObject(obj) { - return Object.getPrototypeOf(obj) === Object.prototype; + return obj !== null && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype; } function isFunction(fn) { return typeof fn === 'function'; }
dantman/wrench
2af9cf46cf7248695c4f75a6b9bb97c944b16577
Implement Object.merge
diff --git a/src/Object.js b/src/Object.js index bb2acae..eb33b3f 100644 --- a/src/Object.js +++ b/src/Object.js @@ -1,68 +1,94 @@ /** * @fileOverview This file contains new methods for the Object class */ /** * @name Object * @class The built-in object class which all objects prototype which acts somewhat like a hash of key/value pairs. */ /** * Returns a new object with the passed object's keys as the new object's values * and the passed object's values as the keys to those values. * * @param {Object} obj The object to create an inverted object from * @return {Object} The inverted object */ Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; +/** + * Merges multiple objects together into the first object with a right dominant pattern. + * This will modify the first object and override methods with the rightmost value. + * + * This method returns the object that was modified, so if you would like a new + * object instead of one of your objects being overwritten use `Object.merge({}, ...);` + * + * @param {Boolean} [deep=false] Use a deep object merge + * @param {Object} ... Objects to merge + * @return {Object} The first object passed to merge + */ Object.merge = function merge() { - + var a = Array.slice(arguments), left, deep = false; + if ( typeof a[0] === 'boolean' ) + deep = a.shift(); + left = a.shift(); + if ( left === null || typeof left !== 'object' ) + throw new TypeError(); + for ( var i = 0, l = a.length; i<l; i++ ) { + var right = a[i]; + for ( var key in right ) + if ( right.hasOwnProperty(key) ) + if ( deep && isObject(left[key]) && isObject(right[key]) ) + left[key] = merge( left[key], right[key] ); + else + left[key] = right[key]; + } + return left; }; /** * Return the number of key/value pairs within an object * * @param {Object} obj The object to count * @return {Number} The number of pairs in the object */ (function(useCount) { Object.count = function count(obj) { if ( useCount ) return obj.__count__; return Object.keys(obj).length; }; })(({}).__count__ === 0); /** * Return an array containing the list of keys within the object * * @param {Object} obj The object to take keys from * @return {Array} The array of keys */ Object.keys = function keys(obj) { var keys = []; for ( var k in obj ) if ( obj.hasOwnProperty( k ) ) keys.push( k ); return keys; }; /** * Return an array containing the list of values within the object * * @param {Object} obj The object to take values from * @return {Array} The array of values */ Object.values = function values(obj) { var values = []; for ( var k in obj ) if ( obj.hasOwnProperty( k ) ) values.push( obj[k] ); return values; };
dantman/wrench
16d0cc24ab47077dbd9366c9c053adb8df42980e
Add is* methods, and Object.getPrototypeOf server side
diff --git a/Makefile b/Makefile index 1854310..79abd1d 100644 --- a/Makefile +++ b/Makefile @@ -1,95 +1,98 @@ SRC_DIR = src BUILD_DIR = build DOC_DIR = doc DIST_DIR = dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.js\ ${SRC_DIR}/String.generic.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ - ${SRC_DIR}/Array.old.js + ${SRC_DIR}/Array.old.js\ + ${SRC_DIR}/Functions.browser.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ - ${SRC_DIR}/Getters.js + ${SRC_DIR}/Getters.js\ + ${SRC_DIR}/Functions.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ - ${SRC_DIR}/Getters.js + ${SRC_DIR}/Getters.js\ + ${SRC_DIR}/Functions.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/ diff --git a/src/Functions.browser.js b/src/Functions.browser.js new file mode 100644 index 0000000..7e136fd --- /dev/null +++ b/src/Functions.browser.js @@ -0,0 +1,24 @@ +(function(toString) { + + function isString(str) { + return typeof str === 'string' || toString(str) === '[object String]'; + } + + function isNumber(num) { + return typeof num === 'number' || toString(num) === '[object Number]'; + } + + function isArray(arr) { + return toString(arr) === '[object Array]'; + } + + function isObject(obj) { + return toString(obj) === '[object Object]'; + } + + function isFunction(fn) { + return toString(fn) === '[object Function]'; + } + +})(Object.prototype.toString); + diff --git a/src/Functions.js b/src/Functions.js new file mode 100644 index 0000000..05a00a2 --- /dev/null +++ b/src/Functions.js @@ -0,0 +1,26 @@ + +if ( !Object.getPrototypeOf ) + Object.getPrototypeOf = function(obj) { + return obj.__proto__; + }; + +function isString(str) { + return typeof str === 'string' || str instanceof String; +} + +function isNumber(num) { + return typeof num === 'number' || num instanceof Number; +} + +function isArray(arr) { + return arr instanceof Array; +} + +function isObject(obj) { + return Object.getPrototypeOf(obj) === Object.prototype; +} + +function isFunction(fn) { + return typeof fn === 'function'; +} +
dantman/wrench
7db370858f31eadcaba6a1efb9e96250283b7501
Add wrench15 wrench17 and wrench18 shortcuts into the Makefile
diff --git a/Makefile b/Makefile index 587ca0e..1854310 100644 --- a/Makefile +++ b/Makefile @@ -1,92 +1,95 @@ SRC_DIR = src BUILD_DIR = build DOC_DIR = doc DIST_DIR = dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.js\ ${SRC_DIR}/String.generic.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} +wrench15: ${WRENCH15} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo +wrench17: ${WRENCH17} ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo +wrench18: ${WRENCH18} ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo docs: -rm -r ${DOC_DIR} java -jar ${BUILD_DIR}/jsdoc-toolkit/jsrun.jar ${BUILD_DIR}/jsdoc-toolkit/app/run.js\ -allfunctions \ -d=${DOC_DIR}/ \ -t=${BUILD_DIR}/template \ -D=rev:`git rev-parse --verify HEAD` \ -E=Array.new.js ${SRC_DIR}/
dantman/wrench
ad3e6d70afe90cf348e03d34a46a4b52683c00ca
Revert commits 9d760dbb9f298de91668fa098325dd4ec9b74b66 and 411623cf2d944352cbe17377da430ecc16135173 JS1.7 does support iterators and yield, I just wasn't running Rhino with -version 170 enabled.
diff --git a/Makefile b/Makefile index b7bed9f..8599679 100644 --- a/Makefile +++ b/Makefile @@ -1,84 +1,85 @@ SRC_DIR = src BUILD_DIR = build PREFIX = . DIST_DIR = ${PREFIX}/dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.js\ ${SRC_DIR}/String.generic.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ + ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo diff --git a/src/Array.iterator.js b/src/Array.iterator.js index 4db685a..fc6ec2b 100644 --- a/src/Array.iterator.js +++ b/src/Array.iterator.js @@ -1,11 +1,11 @@ /** * Define an array iterator. * Using this we never need to hide properties from loops and both for and * for each loop syntax become available for looping over arrays while * guaranteeing that they will also always iterate in order. */ Array.prototype.__iterator__ = function(isKeys) { - for( var i = 0, l = this.length; i<l; ++i ) + for( let i = 0, l = this.length; i<l; ++i ) yield isKeys ? i : this[i]; };
dantman/wrench
0389ede2c2e071d74634ff6ff6d31bad87b69b0e
Implement array.repeat array.flat array.append and array.clean
diff --git a/src/Array.js b/src/Array.js index a237332..db44dd4 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,87 +1,137 @@ /** * Create a new array of a specified length filled with a certain value * * @param size The size of the array to create * @param value The value to populate all the items in the array with */ Array.fill = function fill(size, value) { var arr = new Array(Number(size||0)); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = value; return arr; }; +/** + * Return a new array with the contents of this array repeated over + * `num` amount of times. + * + * @param num Integer The number of times to repeat the array + */ +Array.prototype.repeat = function repeat(num) { + return Array.prototype.concat.apply([], Array.fill(num, this)); +}; + /** * Check if the array contains an item */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return Array A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return Array The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. */ Array.prototype.item = function item(i) { return this[i]; }; /** * Remove the first (or more) occurrence(s) of an item from the array * * @param item The item to remove * @param max The max number of items to remove, use Infinity to remove them all */ Array.prototype.remove = function remove(item, max) { max = max || 1; while(max) { var i = this.indexOf(item); if( i < 0 ) break; this.splice(i, 1); max--; } // ToDo: Determine a reasonable return value }; +/** + * Append a list of items from an array onto the end of this array + * + * @param items Array The array of items to append to this array + */ +Array.prototype.append = function append(items) { + return Array.prototype.push.apply( this, items ); +}; + /** * Clear an array of all items */ Array.prototype.clear = function clear() { return this.splice(0, this.length); }; /** - * Return a random item from an array + * Clean out all undefined and null values inside of an array + * if false is passed to empty then only undefined items are cleaned + * if true is passed to empty then empty strings will also be cleaned + */ +Array.prototype.clean = function clean(empty) { + return this.filter(function(item) { + if ( item === undefined ) return false; + if ( empty !== false && item === null ) return false; + if ( empty === true && item === "" ) return false; + return true; + }); +}; + +/** + * Return a random item from this array. */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; /** * A version of array.reduce() which only passes the two values to reduce on * to the callback so you can use native methods like Math.max inside a reduce. * * @param Function fn The callback function */ Array.prototype.reduceNative = function reduceNative(fn) { return this.reduce(function(a, b) { return fn(a, b); }); }; + +/** + * Returns a new version of this array which has been flattened + * Flattening turns an array like [[1,2,3], [4,5,6], [7,8,9]]; + * into one like [1,2,3,4,5,6,7,8,9]; + */ +Array.prototype.flat = function flat() { + var arr = []; + function reduce(item) { + if( item instanceof Array ) + item.forEach(reduce); + else arr.push(item); + }; + this.forEach(reduce); + return arr; +}; +
dantman/wrench
411623cf2d944352cbe17377da430ecc16135173
JS 1.7 doesn't support yield?
diff --git a/Makefile b/Makefile index 8599679..b7bed9f 100644 --- a/Makefile +++ b/Makefile @@ -1,85 +1,84 @@ SRC_DIR = src BUILD_DIR = build PREFIX = . DIST_DIR = ${PREFIX}/dist FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.js\ ${SRC_DIR}/String.generic.js FILES15 = ${FILES_TOP}\ ${SRC_DIR}/Array16.js\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js FILES17 = ${FILES_TOP}\ ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.old.js\ - ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js FILES18 = ${FILES_TOP}\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.new.js\ ${SRC_DIR}/Array.iterator.js\ ${SRC_DIR}/Getters.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCH17 = ${DIST_DIR}/wrench17.js WRENCH18 = ${DIST_DIR}/wrench18.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ VER15 = sed s/@JSVER/1.5/ VER17 = sed s/@JSVER/1.7/ VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} min: ${WRENCH15_MIN} ${DIST_DIR}: @@mkdir -p ${DIST_DIR} ${WRENCH15}: ${DIST_DIR} ${FILES15} @@echo -n "Building" ${WRENCH15} @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; @@echo " - Done" @@echo ${WRENCH17}: ${DIST_DIR} ${FILES17} @@echo -n "Building" ${WRENCH17} @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; @@echo " - Done" @@echo ${WRENCH18}: ${DIST_DIR} ${FILES18} @@echo -n "Building" ${WRENCH18} @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; @@echo " - Done" @@echo ${WRENCH15_MIN}: ${WRENCH15} @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} @@echo
dantman/wrench
964554285147fd6acfba26a042ae4388000ba1b9
Include extra hash like functionality onto Object.
diff --git a/src/Object.js b/src/Object.js index f9c7a18..92f723f 100644 --- a/src/Object.js +++ b/src/Object.js @@ -1,8 +1,36 @@ -Object.invert = function(obj) { +Object.invert = function invert(obj) { var o = {}; for( var k in obj ) if( obj.hasOwnProperty(k) ) o[obj[k]] = k; return o; }; +Object.merge = function merge() { + +}; + +(function(useCount) { + Object.count = function count(obj) { + if ( useCount ) return obj.__count__; + return Object.keys(obj).length; + }; +})(({}).__count__ === 0); + +Object.keys = function keys(obj) { + var keys = []; + for ( var k in obj ) + if ( obj.hasOwnProperty( k ) ) + keys.push( k ); + return keys; +}; + +Object.values = function values(obj) { + var values = []; + for ( var k in obj ) + if ( obj.hasOwnProperty( k ) ) + values.push( obj[k] ); + return values; +}; + +
dantman/wrench
9d760dbb9f298de91668fa098325dd4ec9b74b66
Minor modification to iterator to support 1.7
diff --git a/src/Array.iterator.js b/src/Array.iterator.js index fc6ec2b..4db685a 100644 --- a/src/Array.iterator.js +++ b/src/Array.iterator.js @@ -1,11 +1,11 @@ /** * Define an array iterator. * Using this we never need to hide properties from loops and both for and * for each loop syntax become available for looping over arrays while * guaranteeing that they will also always iterate in order. */ Array.prototype.__iterator__ = function(isKeys) { - for( let i = 0, l = this.length; i<l; ++i ) + for( var i = 0, l = this.length; i<l; ++i ) yield isKeys ? i : this[i]; };
dantman/wrench
cb7b37ece291cef325ff4be4aaa6a600c2639bc3
Reorganize project files and support JS 1.5 1.7 and 1.8
diff --git a/Makefile b/Makefile index 7095b53..8599679 100644 --- a/Makefile +++ b/Makefile @@ -1,86 +1,85 @@ SRC_DIR = src BUILD_DIR = build PREFIX = . DIST_DIR = ${PREFIX}/dist -BROWSER_FILES = ${SRC_DIR}/top.txt\ +FILES_TOP = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ + ${SRC_DIR}/Number.js\ + ${SRC_DIR}/Math.js\ ${SRC_DIR}/String.js\ - ${SRC_DIR}/String.generic.js\ - ${SRC_DIR}/Array.moz.js\ + ${SRC_DIR}/String.generic.js + +FILES15 = ${FILES_TOP}\ + ${SRC_DIR}/Array16.js\ + ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ - ${SRC_DIR}/Array.15.js\ - ${SRC_DIR}/Array.generic.js\ - ${SRC_DIR}/Number.js\ - ${SRC_DIR}/Math.js + ${SRC_DIR}/Array.old.js -SM_FILES = ${SRC_DIR}/top.txt\ - ${SRC_DIR}/Object.js\ - ${SRC_DIR}/String.js\ - ${SRC_DIR}/String.18.js\ - ${SRC_DIR}/String.generic.js\ +FILES17 = ${FILES_TOP}\ + ${SRC_DIR}/Array18.js\ ${SRC_DIR}/Array.js\ - ${SRC_DIR}/Array.18.js\ - ${SRC_DIR}/Array.generic.js\ - ${SRC_DIR}/Getters.js\ - ${SRC_DIR}/Number.js\ - ${SRC_DIR}/Math.js + ${SRC_DIR}/Array.old.js\ + ${SRC_DIR}/Array.iterator.js\ + ${SRC_DIR}/Getters.js + +FILES18 = ${FILES_TOP}\ + ${SRC_DIR}/Array.js\ + ${SRC_DIR}/Array.new.js\ + ${SRC_DIR}/Array.iterator.js\ + ${SRC_DIR}/Getters.js WRENCH15 = ${DIST_DIR}/wrench15.js -WRENCHSM = ${DIST_DIR}/wrench.sm.js +WRENCH17 = ${DIST_DIR}/wrench17.js +WRENCH18 = ${DIST_DIR}/wrench18.js + WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ -BUILDMODE_15 = sed s/@BUILDTYPE/Browser/ -BUILDMODE_SM = sed s/@BUILDTYPE/Server-side/ +VER15 = sed s/@JSVER/1.5/ +VER17 = sed s/@JSVER/1.7/ +VER18 = sed s/@JSVER/1.8/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." +wrench: ${WRENCH15} ${WRENCH17} ${WRENCH18} +min: ${WRENCH15_MIN} + ${DIST_DIR}: @@mkdir -p ${DIST_DIR} -wrench: ${DIST_DIR} ${WRENCH15} ${WRENCHSM} - -${WRENCHSM}: ${SM_FILES} - @@echo "Building" ${WRENCHSM} - - @@mkdir -p ${DIST_DIR} - @@cat ${SM_FILES} | \ - ${BUILDMODE_SM} | \ - ${VER} > ${WRENCHSM}; - - @@echo ${JQ} "Built" +${WRENCH15}: ${DIST_DIR} ${FILES15} + @@echo -n "Building" ${WRENCH15} + @@cat ${FILES15} | ${VER15} | ${VER} > ${WRENCH15}; + @@echo " - Done" @@echo -${WRENCH15}: ${BROWSER_FILES} - @@echo "Building" ${WRENCH15} - - @@mkdir -p ${DIST_DIR} - @@cat ${BROWSER_FILES} | \ - ${BUILDMODE_15} | \ - ${VER} > ${WRENCH15}; - - @@echo ${JQ} "Built" +${WRENCH17}: ${DIST_DIR} ${FILES17} + @@echo -n "Building" ${WRENCH17} + @@cat ${FILES17} | ${VER17} | ${VER} > ${WRENCH17}; + @@echo " - Done" @@echo - -min: ${WRENCH15_MIN} +${WRENCH18}: ${DIST_DIR} ${FILES18} + @@echo -n "Building" ${WRENCH18} + @@cat ${FILES18} | ${VER18} | ${VER} > ${WRENCH18}; + @@echo " - Done" + @@echo ${WRENCH15_MIN}: ${WRENCH15} - @@echo "Building" ${WRENCH15_MIN} - + @@echo -n "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} - - @@echo ${WRENCH15_MIN} "Built" + @@echo "Done..." @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} + @@echo diff --git a/README b/README index e69de29..b27ac32 100644 --- a/README +++ b/README @@ -0,0 +1,33 @@ +Directory structure +------------------- + + README : This readme file + TODO : ToDo and discussion notes + version.txt : Static version file used when building the project + Makefile : Project makefile for building the project + build/ : Libraries used for building + |- yuicompressor-2.4.2.jar : YUI Compressor for minification of code + ` + src/ : Source files + |- top.txt : Introductory comment block for builds + |- Object.js : Extra Object functions + |- Number.js : Extra Number prototypes + |- Math.js : Extra Math functions + |- Array.js : Extra Array prototypes + |- Array.old.js : Some prototypes from Array.new.js in formats which work in JS 1.5 + |- Array.new.js : Array prototypes which require JS 1.8 to work + |- Array.iterator.js : Bonus Array iterator that makes `for ( var item in [...] )` work + |- Array16.js : Array prototypes added in JS 1.6 + |- Array18.js : Array prototypes added in JS 1.8 + |- Array.generic.js : Array generics + |- String.js : Extra String prototypes + |- String.generic.js : String generics + |- Getters.js : Extra getters which require JS 1.7 + ` + dist/ : Not part of the repo, these are created when the project is built + |- wrench15.js : Wrench.js file for JS 1.5 (ie: Browsers) + |- wrench15.min.js : Minified version of wrench15.js for production use on the web + |- wrench17.js : Wrench.js file for JS 1.7 (ie: Rhino 1.7 and Spidermonkey 1.7) + |- wrench18.js : Wrench.js file for JS 1.8 and above (ie: Spidermonkey 1.8+) + ` + diff --git a/src/Array.iterator.js b/src/Array.iterator.js new file mode 100644 index 0000000..fc6ec2b --- /dev/null +++ b/src/Array.iterator.js @@ -0,0 +1,11 @@ +/** + * Define an array iterator. + * Using this we never need to hide properties from loops and both for and + * for each loop syntax become available for looping over arrays while + * guaranteeing that they will also always iterate in order. + */ +Array.prototype.__iterator__ = function(isKeys) { + for( let i = 0, l = this.length; i<l; ++i ) + yield isKeys ? i : this[i]; +}; + diff --git a/src/Array.18.js b/src/Array.new.js similarity index 65% rename from src/Array.18.js rename to src/Array.new.js index 09aad24..3f37cda 100644 --- a/src/Array.18.js +++ b/src/Array.new.js @@ -1,31 +1,20 @@ -/** - * Define an array iterator. - * Using this we never need to hide properties from loops and both for and - * for each loop syntax become available for looping over arrays while - * guaranteeing that they will also always iterate in order. - */ -Array.prototype.__iterator__ = function(isKeys) { - for( let i = 0, l = this.length; i<l; ++i ) - yield isKeys ? i : this[i]; -}; - /** * Compare this array with another one and return an array with all the items * in this one that are not in the other. * * @param Array otherArray The array to compare to * @return Array An array with all items in this array not in otherArray */ Array.prototype.diff = function(otherArray) [ i for each( i in this ) if( !otherArray.has( i ) ) ]; /** * Compare this array with another one and return an array with all the items * that are in both arrays. * * @param Array otherArray The array to compare to * @return Array An array with all items in this array and otherArray */ Array.prototype.intersect = function(otherArray) [ i for each( i in this ) if( otherArray.has( i ) ) ]; diff --git a/src/Array.15.js b/src/Array.old.js similarity index 100% rename from src/Array.15.js rename to src/Array.old.js diff --git a/src/Array.moz.js b/src/Array16.js similarity index 66% rename from src/Array.moz.js rename to src/Array16.js index e637aa1..e3103b9 100644 --- a/src/Array.moz.js +++ b/src/Array16.js @@ -1,208 +1,131 @@ // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/indexOf if (!Array.prototype.indexOf) { Array.prototype.indexOf = function(elt /*, from*/) { var len = this.length >>> 0; var from = Number(arguments[1]) || 0; from = (from < 0) ? Math.ceil(from) : Math.floor(from); if (from < 0) from += len; for (; from < len; from++) { if (from in this && this[from] === elt) return from; } return -1; }; } // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/lastIndexOf if (!Array.prototype.lastIndexOf) { Array.prototype.lastIndexOf = function(elt /*, from*/) { var len = this.length; var from = Number(arguments[1]); if (isNaN(from)) { from = len - 1; } else { from = (from < 0) ? Math.ceil(from) : Math.floor(from); if (from < 0) from += len; else if (from >= len) from = len - 1; } for (; from > -1; from--) { if (from in this && this[from] === elt) return from; } return -1; }; } // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every if (!Array.prototype.every) { Array.prototype.every = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this && !fun.call(thisp, this[i], i, this)) return false; } return true; }; } // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter if (!Array.prototype.filter) { Array.prototype.filter = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var res = new Array(); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this) { var val = this[i]; // in case fun mutates this if (fun.call(thisp, val, i, this)) res.push(val); } } return res; }; } // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach if (!Array.prototype.forEach) { Array.prototype.forEach = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this) fun.call(thisp, this[i], i, this); } }; } // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map if (!Array.prototype.map) { Array.prototype.map = function(fun /*, thisp*/) { var len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var res = new Array(len); var thisp = arguments[1]; for (var i = 0; i < len; i++) { if (i in this) res[i] = fun.call(thisp, this[i], i, this); } return res; }; } // https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some if (!Array.prototype.some) { Array.prototype.some = function(fun /*, thisp*/) { var i = 0, len = this.length >>> 0; if (typeof fun != "function") throw new TypeError(); var thisp = arguments[1]; for (; i < len; i++) { if (i in this && fun.call(thisp, this[i], i, this)) return true; } return false; }; } -// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduce -if (!Array.prototype.reduce) { - Array.prototype.reduce = function(fun /*, initial*/) { - var len = this.length >>> 0; - if (typeof fun != "function") - throw new TypeError(); - - // no value to return if no initial value and an empty array - if (len == 0 && arguments.length == 1) - throw new TypeError(); - - var i = 0; - if (arguments.length >= 2) - { - var rv = arguments[1]; - } - else - { - do { - if (i in this) { - rv = this[i++]; - break; - } - - // if array contains no values, no initial value to return - if (++i >= len) - throw new TypeError(); - } - while (true); - } - - for (; i < len; i++) { - if (i in this) - rv = fun.call(null, rv, this[i], i, this); - } - - return rv; - }; -} - -// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduceRight -if (!Array.prototype.reduceRight) { - Array.prototype.reduceRight = function(fun /*, initial*/) { - var len = this.length >>> 0; - if (typeof fun != "function") - throw new TypeError(); - - // no value to return if no initial value, empty array - if (len == 0 && arguments.length == 1) - throw new TypeError(); - - var i = len - 1; - if (arguments.length >= 2) { - var rv = arguments[1]; - } else { - do { - if (i in this) { - rv = this[i--]; - break; - } - - // if array contains no values, no initial value to return - if (--i < 0) - throw new TypeError(); - } - while (true); - } - - for (; i >= 0; i--) { - if (i in this) - rv = fun.call(null, rv, this[i], i, this); - } - - return rv; - }; -} - diff --git a/src/Array18.js b/src/Array18.js new file mode 100644 index 0000000..dce2169 --- /dev/null +++ b/src/Array18.js @@ -0,0 +1,77 @@ +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduce +if (!Array.prototype.reduce) { + Array.prototype.reduce = function(fun /*, initial*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + // no value to return if no initial value and an empty array + if (len == 0 && arguments.length == 1) + throw new TypeError(); + + var i = 0; + if (arguments.length >= 2) + { + var rv = arguments[1]; + } + else + { + do { + if (i in this) { + rv = this[i++]; + break; + } + + // if array contains no values, no initial value to return + if (++i >= len) + throw new TypeError(); + } + while (true); + } + + for (; i < len; i++) { + if (i in this) + rv = fun.call(null, rv, this[i], i, this); + } + + return rv; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduceRight +if (!Array.prototype.reduceRight) { + Array.prototype.reduceRight = function(fun /*, initial*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + // no value to return if no initial value, empty array + if (len == 0 && arguments.length == 1) + throw new TypeError(); + + var i = len - 1; + if (arguments.length >= 2) { + var rv = arguments[1]; + } else { + do { + if (i in this) { + rv = this[i--]; + break; + } + + // if array contains no values, no initial value to return + if (--i < 0) + throw new TypeError(); + } + while (true); + } + + for (; i >= 0; i--) { + if (i in this) + rv = fun.call(null, rv, this[i], i, this); + } + + return rv; + }; +} + diff --git a/src/String.18.js b/src/String.18.js deleted file mode 100644 index e69de29..0000000 diff --git a/src/top.txt b/src/top.txt index f22a237..bef8832 100644 --- a/src/top.txt +++ b/src/top.txt @@ -1,29 +1,29 @@ // -*- coding: UTF-8 -*- /*! - * Wrench @BUILDTYPE JavaScript Environment v@VERSION + * Wrench JavaScript @JSVER Environment v@VERSION * http://wrench.monkeyscript.org/ * * Copyright © 2009 Daniel Friesen * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without * restriction, including without limitation the rights to use, * copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following * conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. */
dantman/wrench
0d4eed02c84e5dddc6b96bc94e5f3d1f7074ccca
array.clear();
diff --git a/src/Array.js b/src/Array.js index 80a0c2c..a237332 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,80 +1,87 @@ /** * Create a new array of a specified length filled with a certain value * * @param size The size of the array to create * @param value The value to populate all the items in the array with */ Array.fill = function fill(size, value) { var arr = new Array(Number(size||0)); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = value; return arr; }; /** * Check if the array contains an item */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return Array A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return Array The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. */ Array.prototype.item = function item(i) { return this[i]; }; /** * Remove the first (or more) occurrence(s) of an item from the array * * @param item The item to remove * @param max The max number of items to remove, use Infinity to remove them all */ Array.prototype.remove = function remove(item, max) { max = max || 1; while(max) { var i = this.indexOf(item); if( i < 0 ) break; this.splice(i, 1); max--; } // ToDo: Determine a reasonable return value }; +/** + * Clear an array of all items + */ +Array.prototype.clear = function clear() { + return this.splice(0, this.length); +}; + /** * Return a random item from an array */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; /** * A version of array.reduce() which only passes the two values to reduce on * to the callback so you can use native methods like Math.max inside a reduce. * * @param Function fn The callback function */ Array.prototype.reduceNative = function reduceNative(fn) { return this.reduce(function(a, b) { return fn(a, b); }); };
dantman/wrench
a6d1f927e7387d22895b4062edebaa7aa4d6d5e7
array.remove(item);
diff --git a/src/Array.js b/src/Array.js index b8ea2ff..80a0c2c 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,63 +1,80 @@ /** * Create a new array of a specified length filled with a certain value * * @param size The size of the array to create * @param value The value to populate all the items in the array with */ Array.fill = function fill(size, value) { var arr = new Array(Number(size||0)); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = value; return arr; }; /** * Check if the array contains an item */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return Array A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return Array The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. */ Array.prototype.item = function item(i) { return this[i]; }; +/** + * Remove the first (or more) occurrence(s) of an item from the array + * + * @param item The item to remove + * @param max The max number of items to remove, use Infinity to remove them all + */ +Array.prototype.remove = function remove(item, max) { + max = max || 1; + while(max) { + var i = this.indexOf(item); + if( i < 0 ) break; + this.splice(i, 1); + max--; + } + // ToDo: Determine a reasonable return value +}; + /** * Return a random item from an array */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; /** * A version of array.reduce() which only passes the two values to reduce on * to the callback so you can use native methods like Math.max inside a reduce. * * @param Function fn The callback function */ Array.prototype.reduceNative = function reduceNative(fn) { return this.reduce(function(a, b) { return fn(a, b); }); };
dantman/wrench
7c33554977d64db43ad43f420dd3f313ed237c26
array.reduceNative (So we can do things like [1,2,3].reduceNative(Math.max);) Math.sum and Math.avg
diff --git a/src/Array.js b/src/Array.js index e33cb4b..b8ea2ff 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,54 +1,63 @@ /** * Create a new array of a specified length filled with a certain value * * @param size The size of the array to create * @param value The value to populate all the items in the array with */ Array.fill = function fill(size, value) { var arr = new Array(Number(size||0)); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = value; return arr; }; /** * Check if the array contains an item */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return Array A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return Array The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. */ Array.prototype.item = function item(i) { return this[i]; }; /** * Return a random item from an array */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; +/** + * A version of array.reduce() which only passes the two values to reduce on + * to the callback so you can use native methods like Math.max inside a reduce. + * + * @param Function fn The callback function + */ +Array.prototype.reduceNative = function reduceNative(fn) { + return this.reduce(function(a, b) { return fn(a, b); }); +}; diff --git a/src/Math.js b/src/Math.js index 0f663f1..b1e8c7c 100644 --- a/src/Math.js +++ b/src/Math.js @@ -1,9 +1,30 @@ /** * Extension to Math.random which returns an integer between 2 values instead of * a random float. * Partly borrowed from https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/random#Example.3a_Using_Math.random */ Math.rand = function rand(min, max) { return Math.floor( Math.random() * ( max - min + 1 ) ) + min; }; +/** + * Calculate the sum of a list of numbers. Is also useful as an argument to .reduceNative + */ +if(!Math.sum) + Math.sum = function sum(/*...*/) { + if( !arguments.length ) + throw new TypeError(); + var args = Array.slice(arguments); + var s = args.shift(); + while( args.length ) + s += args.shift(); + return s; + }; + +/** + * Calculate the average value from a list of numbers. + */ +Math.avg = function avg(/*...*/) { + return Math.sum.apply(Math, arguments) / arguments.length; +}; +
dantman/wrench
77860190308ade725349d4d6bc5e1714f8364574
Add number and string padding
diff --git a/Makefile b/Makefile index 18d60a3..7095b53 100644 --- a/Makefile +++ b/Makefile @@ -1,84 +1,86 @@ SRC_DIR = src BUILD_DIR = build PREFIX = . DIST_DIR = ${PREFIX}/dist BROWSER_FILES = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/String.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.moz.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.15.js\ ${SRC_DIR}/Array.generic.js\ + ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js SM_FILES = ${SRC_DIR}/top.txt\ ${SRC_DIR}/Object.js\ ${SRC_DIR}/String.js\ ${SRC_DIR}/String.18.js\ ${SRC_DIR}/String.generic.js\ ${SRC_DIR}/Array.js\ ${SRC_DIR}/Array.18.js\ ${SRC_DIR}/Array.generic.js\ ${SRC_DIR}/Getters.js\ + ${SRC_DIR}/Number.js\ ${SRC_DIR}/Math.js WRENCH15 = ${DIST_DIR}/wrench15.js WRENCHSM = ${DIST_DIR}/wrench.sm.js WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js WRENCH_VER = `cat version.txt` VER = sed s/@VERSION/${WRENCH_VER}/ BUILDMODE_15 = sed s/@BUILDTYPE/Browser/ BUILDMODE_SM = sed s/@BUILDTYPE/Server-side/ MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar all: wrench min @@echo "Wrench build complete." ${DIST_DIR}: @@mkdir -p ${DIST_DIR} wrench: ${DIST_DIR} ${WRENCH15} ${WRENCHSM} ${WRENCHSM}: ${SM_FILES} @@echo "Building" ${WRENCHSM} @@mkdir -p ${DIST_DIR} @@cat ${SM_FILES} | \ ${BUILDMODE_SM} | \ ${VER} > ${WRENCHSM}; @@echo ${JQ} "Built" @@echo ${WRENCH15}: ${BROWSER_FILES} @@echo "Building" ${WRENCH15} @@mkdir -p ${DIST_DIR} @@cat ${BROWSER_FILES} | \ ${BUILDMODE_15} | \ ${VER} > ${WRENCH15}; @@echo ${JQ} "Built" @@echo min: ${WRENCH15_MIN} ${WRENCH15_MIN}: ${WRENCH15} @@echo "Building" ${WRENCH15_MIN} @@echo " - Compressing using YUI Compressor" @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} @@echo ${WRENCH15_MIN} "Built" @@echo clean: @@echo "Removing Distribution directory:" ${DIST_DIR} @@rm -rf ${DIST_DIR} diff --git a/src/Number.js b/src/Number.js new file mode 100644 index 0000000..b80f6e5 --- /dev/null +++ b/src/Number.js @@ -0,0 +1,11 @@ +/** + * Return a padded string for the number. By defeault this function zero fills. + * + * @param len The minimum lenght of the string to return + * @param chars Characters to use when padding the number, defaulting to zero padding + * @param radix An optional radix to use when turning the number into a string + */ +Number.prototype.pad = function pad(len, chars, radix) { + return this.toString(radix || 10).padLeft(len || 0, chars || "0"); +}; + diff --git a/src/String.js b/src/String.js index 31e660c..1815604 100644 --- a/src/String.js +++ b/src/String.js @@ -1,209 +1,211 @@ /** * Repeat a string a number of times. * * @param int num The number of times to repeat * @param String separator An optional separator to insert in between the strings * @return String the repeated string */ String.prototype.repeat = function repeat(num, separator) { return Array.fill(num||1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param int len The length of the string to expand to * @return String the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return String The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return String The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return String The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return Boolean A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return Boolean A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return Boolean A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param other The substring to search for * @param offset An optional offset from the start of the string for the search * @return Number An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return String A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; -String.prototype.pad = function pad() { - +String.prototype.pad = function pad(len, chars) { + return this.padLeft(Math.floor(len/2), chars).padRight(Math.ceil(len/2), chars); }; -String.prototype.padLeft = function padLeft() { - +String.prototype.padLeft = function padLeft(len, chars) { + chars = chars || ' '; + return chars.expand(Math.max(0, len - this.length)) + this; }; String.prototype.padRight = function padRight() { - + chars = chars || ' '; + return this + chars.expand(Math.max(0, len - this.length)); }; String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex) { }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
01df92ab48fea902824f25151cda0f17bfa5037a
Support separator in string.repeat()
diff --git a/src/String.js b/src/String.js index 0da1b9c..31e660c 100644 --- a/src/String.js +++ b/src/String.js @@ -1,208 +1,209 @@ /** * Repeat a string a number of times. * * @param int num The number of times to repeat + * @param String separator An optional separator to insert in between the strings * @return String the repeated string */ -String.prototype.repeat = function repeat(num) { - return Array.fill(num||1, this).join(''); +String.prototype.repeat = function repeat(num, separator) { + return Array.fill(num||1, this).join(separator||''); }; /** * Expand a string repeating it up to a certain length. * * @param int len The length of the string to expand to * @return String the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return String The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return String The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return String The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return Boolean A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return Boolean A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return Boolean A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param other The substring to search for * @param offset An optional offset from the start of the string for the search * @return Number An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return String A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; String.prototype.pad = function pad() { }; String.prototype.padLeft = function padLeft() { }; String.prototype.padRight = function padRight() { }; String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex) { }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
7810a4b045a7a54071f660dba2c1182c34097528
Implement Array.fill() and convert string.repeat() to a shorter version that uses it.
diff --git a/src/Array.js b/src/Array.js index 1b49058..e33cb4b 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,41 +1,54 @@ +/** + * Create a new array of a specified length filled with a certain value + * + * @param size The size of the array to create + * @param value The value to populate all the items in the array with + */ +Array.fill = function fill(size, value) { + var arr = new Array(Number(size||0)); + for ( var i = arr.length-1; i >= 0; --i ) + arr[i] = value; + return arr; +}; + /** * Check if the array contains an item */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return Array A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return Array The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. */ Array.prototype.item = function item(i) { return this[i]; }; /** * Return a random item from an array */ Array.prototype.rand = function() { return this[Math.rand(0, this.length-1)]; }; diff --git a/src/String.js b/src/String.js index d44ad1d..0da1b9c 100644 --- a/src/String.js +++ b/src/String.js @@ -1,211 +1,208 @@ /** * Repeat a string a number of times. * * @param int num The number of times to repeat * @return String the repeated string */ String.prototype.repeat = function repeat(num) { - var arr = new Array(num||1); - for ( var i = arr.length-1; i >= 0; --i ) - arr[i] = this; - return arr.join(''); + return Array.fill(num||1, this).join(''); }; /** * Expand a string repeating it up to a certain length. * * @param int len The length of the string to expand to * @return String the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return String The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return String The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); }; /** * Return a version fo this string with all words matched by \w given an upper * case first character. * * @return String The string with the modified case */ String.prototype.toTitleCase = function toTitleCase() { return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); }; /** * Check and see if this string starts with another * * @return Boolean A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return Boolean A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return Boolean A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param other The substring to search for * @param offset An optional offset from the start of the string for the search * @return Number An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return String A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; String.prototype.pad = function pad() { }; String.prototype.padLeft = function padLeft() { }; String.prototype.padRight = function padRight() { }; String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex) { }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
a568059bef03d1241e414f9a0ba2cf10e56e57a6
string.toTitleCase()
diff --git a/src/String.js b/src/String.js index 58f1a8c..d44ad1d 100644 --- a/src/String.js +++ b/src/String.js @@ -1,201 +1,211 @@ /** * Repeat a string a number of times. * * @param int num The number of times to repeat * @return String the repeated string */ String.prototype.repeat = function repeat(num) { var arr = new Array(num||1); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = this; return arr.join(''); }; /** * Expand a string repeating it up to a certain length. * * @param int len The length of the string to expand to * @return String the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return String The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return String The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); -} +}; + +/** + * Return a version fo this string with all words matched by \w given an upper + * case first character. + * + * @return String The string with the modified case + */ +String.prototype.toTitleCase = function toTitleCase() { + return this.replace(/\w+/g, function(m) { return m.toFirstUpperCase(); }); +}; /** * Check and see if this string starts with another * * @return Boolean A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return Boolean A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return Boolean A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param other The substring to search for * @param offset An optional offset from the start of the string for the search * @return Number An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return String A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; // This creates a table where chars[char] will be truthy/falsey for inclusion var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; String.prototype.pad = function pad() { }; String.prototype.padLeft = function padLeft() { }; String.prototype.padRight = function padRight() { }; String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex) { }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
5e8e8b80ce255fc8446444b1e71399c972808d8e
.diff() and .intersect() for js1.5
diff --git a/src/Array.15.js b/src/Array.15.js index 71ddab3..9267749 100644 --- a/src/Array.15.js +++ b/src/Array.15.js @@ -1,12 +1,26 @@ -Array.prototype.diff = function intersect() { - +/** + * Compare this array with another one and return an array with all the items + * in this one that are not in the other. + * + * @param Array otherArray The array to compare to + * @return Array An array with all items in this array not in otherArray + */ +Array.prototype.diff = function diff(otherArray) { + return this.filter(function(item) { + return !otherArray.has(item); + }); }; -Array.prototype.intersect = function intersect() { - -}; - -Array.prototype.union = function union() { - +/** + * Compare this array with another one and return an array with all the items + * that are in both arrays. + * + * @param Array otherArray The array to compare to + * @return Array An array with all items in this array and otherArray + */ +Array.prototype.intersect = function intersect(otherArray) { + return this.filter(function(item) { + return otherArray.has(item); + }); };
dantman/wrench
5f6635e3fa950c4fbbf307be72a65c09bc31f7ef
array.rand();
diff --git a/src/Array.js b/src/Array.js index bee1646..1b49058 100644 --- a/src/Array.js +++ b/src/Array.js @@ -1,34 +1,41 @@ /** * Check if the array contains an item */ Array.prototype.has = function has(item) { return this.indexOf(item) > -1; }; /** * Return an array where all duplicate items have been removed * * @return Array A new array with a unique list of all items in this array */ Array.prototype.unique = function unique() { return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); }; /** * Shuffle the array * * @return Array The same array for convenience */ Array.prototype.shuffle = function shuffle() { return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); }; /** * Return an item from an index in the array * This is provided for client-side convenience so you have the same technique * for getting an item on both an array and a list of html nodes. */ Array.prototype.item = function item(i) { return this[i]; }; +/** + * Return a random item from an array + */ +Array.prototype.rand = function() { + return this[Math.rand(0, this.length-1)]; +}; +
dantman/wrench
ec3d540d4682122e2c57ac3985c05986c7dd1931
Fix compatibility bug and use hasOwnProperty in Object.invert
diff --git a/src/Object.js b/src/Object.js index 491150a..f9c7a18 100644 --- a/src/Object.js +++ b/src/Object.js @@ -1,6 +1,8 @@ Object.invert = function(obj) { var o = {}; - for( var k in obj ) o[obj[k]] = k; + for( var k in obj ) + if( obj.hasOwnProperty(k) ) + o[obj[k]] = k; return o; }; diff --git a/src/String.js b/src/String.js index 9df8f8a..58f1a8c 100644 --- a/src/String.js +++ b/src/String.js @@ -1,200 +1,201 @@ /** * Repeat a string a number of times. * * @param int num The number of times to repeat * @return String the repeated string */ String.prototype.repeat = function repeat(num) { var arr = new Array(num||1); for ( var i = arr.length-1; i >= 0; --i ) arr[i] = this; return arr.join(''); }; /** * Expand a string repeating it up to a certain length. * * @param int len The length of the string to expand to * @return String the expanded string */ String.prototype.expand = function expand(len) { return this.repeat(Math.ceil(len / this.length)).substr(0, len); }; /** * Return a version of this string with the first character in upper case * * @return String The string with the modified case */ String.prototype.toFirstUpperCase = function toFirstUpperCase() { return this.charAt(0).toUpperCase() + this.substr(1); }; /** * Return a version of this string with the first character in lower case * * @return String The string with the modified case */ String.prototype.toFirstLowerCase = function toFirstLowerCase() { return this.charAt(0).toLowerCase() + this.substr(1); } /** * Check and see if this string starts with another * * @return Boolean A boolean indicating if this string starts with another */ String.prototype.startsWith = function startsWith(other) { return this.substr(0, other.length) === other; }; /** * Check and see if this string ends with another * * @return Boolean A boolean indicating if this string ends with another */ String.prototype.endsWith = function endsWith(other) { return this.substr(-other.length) === other; }; /** * Check and see if this string contains another * * @return Boolean A boolean indicating if this string contains another */ String.prototype.contains = function contains(other) { return this.indexOf(other) > -1; }; /** * Count the number of times a substring is found within this string * * @param other The substring to search for * @param offset An optional offset from the start of the string for the search * @return Number An integer indicating how many times the substring is found */ String.prototype.numberOf = function numberOf(other, offset) { offset = offset || 0; var i, c = 0; while( (i = this.indexOf(other, offset)) && i >= 0 ) { c++; offset = i + other.length; } return c; }; /** * Reverse the order of characters in this string * * @return String A new string with characters in the reverse order */ String.prototype.reverse = function reverse() { return this.split('').reverse().join(''); }; if ( !String.prototype.trimLeft ) String.prototype.trimLeft = function trimLeft() { return this.replace(/^\s\s*/, ''); }; if ( !String.prototype.trimRight ) String.prototype.trimRight = function trimRight() { return this.replace(/\s*\s*$/, ''); }; if ( !String.prototype.trim ) String.prototype.trim = function trim() { return this.trimLeft().trimRight(); }; String.prototype.strip = function strip(chars, internal) { if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); internal = internal || 3; - var chars = Object.invert(chars); // This creates a table where chars[char] will be truthy/falsey for inclusion + // This creates a table where chars[char] will be truthy/falsey for inclusion + var chars = Object.invert(typeof chars === 'string' ? chars.split('') : chars); var start = 0, end = this.length; if ( internal & 1 ) { // Left while( this.charAt(start) in chars ) start++; } if ( internal & 2 ) { // Right while( this.charAt(end-1) in chars && end > start ) end--; } return this.substring(start, end); }; String.prototype.stripLeft = function stripLeft(chars) { return this.strip(chars, 1); }; String.prototype.stripRight = function stripRight(chars) { return this.strip(chars, 2); }; String.prototype.pad = function pad() { }; String.prototype.padLeft = function padLeft() { }; String.prototype.padRight = function padRight() { }; String.prototype.partition = function partition(sep) { if ( sep instanceof RegExp ) { var m = this.match(m); var i = m ? m.index : -1; sep = m[0]; } else { var i = this.indexOf(sep); } var l = sep.length; return i > -1 ? [ this.substr(0, i), sep, this.substr(i+l) ] : [ this, '', '' ]; }; String.prototype.partitionRight = function partitionRight(sep) { var i = this.lastIndexOf(sep); return i > -1 ? [ this.substr(0, i), sep, this.substr(i+sep.length) ] : [ '', '', this ]; }; String.prototype.explode = function explode(sep, limit) { }; String.prototype.scan = function scan(regex) { }; /** * Converts a dash (foo-bar) or underscore (foo_bar) style name into a * cammel case (fooBar) name. */ String.prototype.toCamelCase = function toCamelCase() { return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); }; /** * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. */ String.prototype.toUnderscore = function toUnderscore() { return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); }; /** * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. */ String.prototype.toDash = function toDash() { return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); };
dantman/wrench
9f38b1b42b1fc73c0876dc24a2c0facab59d6d51
Use a proper MIT License boilerplate
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1a782cf --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*~ +dist/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..18d60a3 --- /dev/null +++ b/Makefile @@ -0,0 +1,84 @@ +SRC_DIR = src +BUILD_DIR = build + +PREFIX = . +DIST_DIR = ${PREFIX}/dist + +BROWSER_FILES = ${SRC_DIR}/top.txt\ + ${SRC_DIR}/Object.js\ + ${SRC_DIR}/String.js\ + ${SRC_DIR}/String.generic.js\ + ${SRC_DIR}/Array.moz.js\ + ${SRC_DIR}/Array.js\ + ${SRC_DIR}/Array.15.js\ + ${SRC_DIR}/Array.generic.js\ + ${SRC_DIR}/Math.js + +SM_FILES = ${SRC_DIR}/top.txt\ + ${SRC_DIR}/Object.js\ + ${SRC_DIR}/String.js\ + ${SRC_DIR}/String.18.js\ + ${SRC_DIR}/String.generic.js\ + ${SRC_DIR}/Array.js\ + ${SRC_DIR}/Array.18.js\ + ${SRC_DIR}/Array.generic.js\ + ${SRC_DIR}/Getters.js\ + ${SRC_DIR}/Math.js + +WRENCH15 = ${DIST_DIR}/wrench15.js +WRENCHSM = ${DIST_DIR}/wrench.sm.js +WRENCH15_MIN = ${DIST_DIR}/wrench15.min.js + +WRENCH_VER = `cat version.txt` +VER = sed s/@VERSION/${WRENCH_VER}/ +BUILDMODE_15 = sed s/@BUILDTYPE/Browser/ +BUILDMODE_SM = sed s/@BUILDTYPE/Server-side/ + +MINJAR = java -jar ${BUILD_DIR}/yuicompressor-2.4.2.jar + +all: wrench min + @@echo "Wrench build complete." + +${DIST_DIR}: + @@mkdir -p ${DIST_DIR} + +wrench: ${DIST_DIR} ${WRENCH15} ${WRENCHSM} + +${WRENCHSM}: ${SM_FILES} + @@echo "Building" ${WRENCHSM} + + @@mkdir -p ${DIST_DIR} + @@cat ${SM_FILES} | \ + ${BUILDMODE_SM} | \ + ${VER} > ${WRENCHSM}; + + @@echo ${JQ} "Built" + @@echo + +${WRENCH15}: ${BROWSER_FILES} + @@echo "Building" ${WRENCH15} + + @@mkdir -p ${DIST_DIR} + @@cat ${BROWSER_FILES} | \ + ${BUILDMODE_15} | \ + ${VER} > ${WRENCH15}; + + @@echo ${JQ} "Built" + @@echo + + +min: ${WRENCH15_MIN} + +${WRENCH15_MIN}: ${WRENCH15} + @@echo "Building" ${WRENCH15_MIN} + + @@echo " - Compressing using YUI Compressor" + @@${MINJAR} ${WRENCH15} > ${WRENCH15_MIN} + + @@echo ${WRENCH15_MIN} "Built" + @@echo + +clean: + @@echo "Removing Distribution directory:" ${DIST_DIR} + @@rm -rf ${DIST_DIR} + diff --git a/README b/README new file mode 100644 index 0000000..e69de29 diff --git a/TODO b/TODO new file mode 100644 index 0000000..ee2f8b4 --- /dev/null +++ b/TODO @@ -0,0 +1,7 @@ +- Should we add Object.invert? +Object.invert = function(obj) { + var o = {}; + for( let k in obj ) o[obj[k]] = k; + return o; +}; +- We have string.contains and array.has, should we pick one name for both instead? diff --git a/build/yuicompressor-2.4.2.jar b/build/yuicompressor-2.4.2.jar new file mode 100644 index 0000000..c29470b Binary files /dev/null and b/build/yuicompressor-2.4.2.jar differ diff --git a/src/Array.15.js b/src/Array.15.js new file mode 100644 index 0000000..71ddab3 --- /dev/null +++ b/src/Array.15.js @@ -0,0 +1,12 @@ +Array.prototype.diff = function intersect() { + +}; + +Array.prototype.intersect = function intersect() { + +}; + +Array.prototype.union = function union() { + +}; + diff --git a/src/Array.18.js b/src/Array.18.js new file mode 100644 index 0000000..09aad24 --- /dev/null +++ b/src/Array.18.js @@ -0,0 +1,31 @@ +/** + * Define an array iterator. + * Using this we never need to hide properties from loops and both for and + * for each loop syntax become available for looping over arrays while + * guaranteeing that they will also always iterate in order. + */ +Array.prototype.__iterator__ = function(isKeys) { + for( let i = 0, l = this.length; i<l; ++i ) + yield isKeys ? i : this[i]; +}; + +/** + * Compare this array with another one and return an array with all the items + * in this one that are not in the other. + * + * @param Array otherArray The array to compare to + * @return Array An array with all items in this array not in otherArray + */ +Array.prototype.diff = + function(otherArray) [ i for each( i in this ) if( !otherArray.has( i ) ) ]; + +/** + * Compare this array with another one and return an array with all the items + * that are in both arrays. + * + * @param Array otherArray The array to compare to + * @return Array An array with all items in this array and otherArray + */ +Array.prototype.intersect = + function(otherArray) [ i for each( i in this ) if( otherArray.has( i ) ) ]; + diff --git a/src/Array.generic.js b/src/Array.generic.js new file mode 100644 index 0000000..aa6b20c --- /dev/null +++ b/src/Array.generic.js @@ -0,0 +1,13 @@ +Array.slice = function slice(arr) { + return Array.prototype.slice.apply(arr, Array.prototype.slice.call(arguments, 1)); +}; + +(function fn(method) { + if(method in Array) return fn; + Array[method] = function(arr) { + return Array.prototype[method].apply(arr, Array.slice(arguments, 1)); + }; + return fn; +})('diff')('intersect')('unique')('shuffle')('item')('has')('indexOf')('lastIndexOf') +('every')('some')('filter')('forEach')('map')('reduce')('reduceRight')('join'); + diff --git a/src/Array.js b/src/Array.js new file mode 100644 index 0000000..bee1646 --- /dev/null +++ b/src/Array.js @@ -0,0 +1,34 @@ +/** + * Check if the array contains an item + */ +Array.prototype.has = function has(item) { + return this.indexOf(item) > -1; +}; + +/** + * Return an array where all duplicate items have been removed + * + * @return Array A new array with a unique list of all items in this array + */ +Array.prototype.unique = function unique() { + return this.filter(function(item, i, arr) { return arr.indexOf(item) >= i; }); +}; + +/** + * Shuffle the array + * + * @return Array The same array for convenience + */ +Array.prototype.shuffle = function shuffle() { + return this.sort(function() { return Math.random() > 0.5 ? 1 : -1; }); +}; + +/** + * Return an item from an index in the array + * This is provided for client-side convenience so you have the same technique + * for getting an item on both an array and a list of html nodes. + */ +Array.prototype.item = function item(i) { + return this[i]; +}; + diff --git a/src/Array.moz.js b/src/Array.moz.js new file mode 100644 index 0000000..e637aa1 --- /dev/null +++ b/src/Array.moz.js @@ -0,0 +1,208 @@ +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/indexOf +if (!Array.prototype.indexOf) { + Array.prototype.indexOf = function(elt /*, from*/) { + var len = this.length >>> 0; + + var from = Number(arguments[1]) || 0; + from = (from < 0) ? Math.ceil(from) : Math.floor(from); + if (from < 0) + from += len; + + for (; from < len; from++) { + if (from in this && this[from] === elt) + return from; + } + return -1; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/lastIndexOf +if (!Array.prototype.lastIndexOf) { + Array.prototype.lastIndexOf = function(elt /*, from*/) { + var len = this.length; + + var from = Number(arguments[1]); + if (isNaN(from)) { + from = len - 1; + } else { + from = (from < 0) ? Math.ceil(from) : Math.floor(from); + if (from < 0) + from += len; + else if (from >= len) + from = len - 1; + } + + for (; from > -1; from--) { + if (from in this && this[from] === elt) + return from; + } + return -1; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every +if (!Array.prototype.every) { + Array.prototype.every = function(fun /*, thisp*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + var thisp = arguments[1]; + for (var i = 0; i < len; i++) { + if (i in this && !fun.call(thisp, this[i], i, this)) + return false; + } + + return true; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter +if (!Array.prototype.filter) { + Array.prototype.filter = function(fun /*, thisp*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + var res = new Array(); + var thisp = arguments[1]; + for (var i = 0; i < len; i++) { + if (i in this) { + var val = this[i]; // in case fun mutates this + if (fun.call(thisp, val, i, this)) + res.push(val); + } + } + + return res; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach +if (!Array.prototype.forEach) { + Array.prototype.forEach = function(fun /*, thisp*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + var thisp = arguments[1]; + for (var i = 0; i < len; i++) { + if (i in this) + fun.call(thisp, this[i], i, this); + } + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map +if (!Array.prototype.map) { + Array.prototype.map = function(fun /*, thisp*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + var res = new Array(len); + var thisp = arguments[1]; + for (var i = 0; i < len; i++) { + if (i in this) + res[i] = fun.call(thisp, this[i], i, this); + } + + return res; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some +if (!Array.prototype.some) { + Array.prototype.some = function(fun /*, thisp*/) { + var i = 0, len = this.length >>> 0; + + if (typeof fun != "function") + throw new TypeError(); + + var thisp = arguments[1]; + for (; i < len; i++) { + if (i in this && fun.call(thisp, this[i], i, this)) + return true; + } + + return false; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduce +if (!Array.prototype.reduce) { + Array.prototype.reduce = function(fun /*, initial*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + // no value to return if no initial value and an empty array + if (len == 0 && arguments.length == 1) + throw new TypeError(); + + var i = 0; + if (arguments.length >= 2) + { + var rv = arguments[1]; + } + else + { + do { + if (i in this) { + rv = this[i++]; + break; + } + + // if array contains no values, no initial value to return + if (++i >= len) + throw new TypeError(); + } + while (true); + } + + for (; i < len; i++) { + if (i in this) + rv = fun.call(null, rv, this[i], i, this); + } + + return rv; + }; +} + +// https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/reduceRight +if (!Array.prototype.reduceRight) { + Array.prototype.reduceRight = function(fun /*, initial*/) { + var len = this.length >>> 0; + if (typeof fun != "function") + throw new TypeError(); + + // no value to return if no initial value, empty array + if (len == 0 && arguments.length == 1) + throw new TypeError(); + + var i = len - 1; + if (arguments.length >= 2) { + var rv = arguments[1]; + } else { + do { + if (i in this) { + rv = this[i--]; + break; + } + + // if array contains no values, no initial value to return + if (--i < 0) + throw new TypeError(); + } + while (true); + } + + for (; i >= 0; i--) { + if (i in this) + rv = fun.call(null, rv, this[i], i, this); + } + + return rv; + }; +} + diff --git a/src/Getters.js b/src/Getters.js new file mode 100644 index 0000000..75b06be --- /dev/null +++ b/src/Getters.js @@ -0,0 +1,5 @@ +String.prototype.__defineGetter__( 'uc', String.prototype.toUpperCase ); +String.prototype.__defineGetter__( 'lc', String.prototype.toLowerCase ); +String.prototype.__defineGetter__( 'ucfirst', String.prototype.toFirstUpperCase ); +String.prototype.__defineGetter__( 'lcfirst', String.prototype.toFirstLowerCase ); + diff --git a/src/Math.js b/src/Math.js new file mode 100644 index 0000000..0f663f1 --- /dev/null +++ b/src/Math.js @@ -0,0 +1,9 @@ +/** + * Extension to Math.random which returns an integer between 2 values instead of + * a random float. + * Partly borrowed from https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Math/random#Example.3a_Using_Math.random + */ +Math.rand = function rand(min, max) { + return Math.floor( Math.random() * ( max - min + 1 ) ) + min; +}; + diff --git a/src/Object.js b/src/Object.js new file mode 100644 index 0000000..491150a --- /dev/null +++ b/src/Object.js @@ -0,0 +1,6 @@ +Object.invert = function(obj) { + var o = {}; + for( var k in obj ) o[obj[k]] = k; + return o; +}; + diff --git a/src/String.18.js b/src/String.18.js new file mode 100644 index 0000000..e69de29 diff --git a/src/String.generic.js b/src/String.generic.js new file mode 100644 index 0000000..709f3bd --- /dev/null +++ b/src/String.generic.js @@ -0,0 +1,9 @@ +(function fn(method) { + if(method in String) return fn; + String[method] = function(arr) { + return String.prototype[method].apply(arr, Array.slice(arguments, 1)); + }; + return fn; +})('split')('explode') +('repeat')('expand'); + diff --git a/src/String.js b/src/String.js new file mode 100644 index 0000000..9df8f8a --- /dev/null +++ b/src/String.js @@ -0,0 +1,200 @@ +/** + * Repeat a string a number of times. + * + * @param int num The number of times to repeat + * @return String the repeated string + */ +String.prototype.repeat = function repeat(num) { + var arr = new Array(num||1); + for ( var i = arr.length-1; i >= 0; --i ) + arr[i] = this; + return arr.join(''); +}; + +/** + * Expand a string repeating it up to a certain length. + * + * @param int len The length of the string to expand to + * @return String the expanded string + */ +String.prototype.expand = function expand(len) { + return this.repeat(Math.ceil(len / this.length)).substr(0, len); +}; + +/** + * Return a version of this string with the first character in upper case + * + * @return String The string with the modified case + */ +String.prototype.toFirstUpperCase = function toFirstUpperCase() { + return this.charAt(0).toUpperCase() + this.substr(1); +}; + +/** + * Return a version of this string with the first character in lower case + * + * @return String The string with the modified case + */ +String.prototype.toFirstLowerCase = function toFirstLowerCase() { + return this.charAt(0).toLowerCase() + this.substr(1); +} + +/** + * Check and see if this string starts with another + * + * @return Boolean A boolean indicating if this string starts with another + */ +String.prototype.startsWith = function startsWith(other) { + return this.substr(0, other.length) === other; +}; + +/** + * Check and see if this string ends with another + * + * @return Boolean A boolean indicating if this string ends with another + */ +String.prototype.endsWith = function endsWith(other) { + return this.substr(-other.length) === other; +}; + +/** + * Check and see if this string contains another + * + * @return Boolean A boolean indicating if this string contains another + */ +String.prototype.contains = function contains(other) { + return this.indexOf(other) > -1; +}; + +/** + * Count the number of times a substring is found within this string + * + * @param other The substring to search for + * @param offset An optional offset from the start of the string for the search + * @return Number An integer indicating how many times the substring is found + */ +String.prototype.numberOf = function numberOf(other, offset) { + offset = offset || 0; + var i, c = 0; + while( (i = this.indexOf(other, offset)) && i >= 0 ) { + c++; + offset = i + other.length; + } + return c; +}; + +/** + * Reverse the order of characters in this string + * + * @return String A new string with characters in the reverse order + */ +String.prototype.reverse = function reverse() { + return this.split('').reverse().join(''); +}; + +if ( !String.prototype.trimLeft ) + String.prototype.trimLeft = function trimLeft() { + return this.replace(/^\s\s*/, ''); + }; + +if ( !String.prototype.trimRight ) + String.prototype.trimRight = function trimRight() { + return this.replace(/\s*\s*$/, ''); + }; + +if ( !String.prototype.trim ) + String.prototype.trim = function trim() { + return this.trimLeft().trimRight(); + }; + +String.prototype.strip = function strip(chars, internal) { + if(!chars) throw new TypeError("Stripping requires a list of characters to strip"); + internal = internal || 3; + var chars = Object.invert(chars); // This creates a table where chars[char] will be truthy/falsey for inclusion + + var start = 0, end = this.length; + + if ( internal & 1 ) { // Left + while( this.charAt(start) in chars ) + start++; + } + if ( internal & 2 ) { // Right + while( this.charAt(end-1) in chars && end > start ) + end--; + } + + return this.substring(start, end); +}; + +String.prototype.stripLeft = function stripLeft(chars) { + return this.strip(chars, 1); +}; + +String.prototype.stripRight = function stripRight(chars) { + return this.strip(chars, 2); +}; + +String.prototype.pad = function pad() { + +}; + +String.prototype.padLeft = function padLeft() { + +}; + +String.prototype.padRight = function padRight() { + +}; + +String.prototype.partition = function partition(sep) { + if ( sep instanceof RegExp ) { + var m = this.match(m); + var i = m ? m.index : -1; + sep = m[0]; + } else { + var i = this.indexOf(sep); + } + var l = sep.length; + + return i > -1 ? + [ this.substr(0, i), sep, this.substr(i+l) ] : + [ this, '', '' ]; +}; + +String.prototype.partitionRight = function partitionRight(sep) { + var i = this.lastIndexOf(sep); + return i > -1 ? + [ this.substr(0, i), sep, this.substr(i+sep.length) ] : + [ '', '', this ]; +}; + +String.prototype.explode = function explode(sep, limit) { + +}; + +String.prototype.scan = function scan(regex) { + +}; + +/** + * Converts a dash (foo-bar) or underscore (foo_bar) style name into a + * cammel case (fooBar) name. + */ +String.prototype.toCamelCase = function toCamelCase() { + return this.replace(/[-_][a-z]/g, function(i) { return i[1].toUpperCase(); }); +}; + +/** + * Converts a cammel case (fooBar) name into an underscore (foo_bar) style name. + */ +String.prototype.toUnderscore = function toUnderscore() { + return this.replace(/[A-Z]/, function(i) { return '_' + i.toLowerCase(); }); +}; + +/** + * Converts a cammel case (fooBar) name into a dash (foo-bar) style name. + */ +String.prototype.toDash = function toDash() { + return this.replace(/[A-Z]/, function(i) { return '-' + i.toLowerCase(); }); +}; + diff --git a/src/top.txt b/src/top.txt new file mode 100644 index 0000000..f22a237 --- /dev/null +++ b/src/top.txt @@ -0,0 +1,29 @@ +// -*- coding: UTF-8 -*- +/*! + * Wrench @BUILDTYPE JavaScript Environment v@VERSION + * http://wrench.monkeyscript.org/ + * + * Copyright © 2009 Daniel Friesen + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ + diff --git a/version.txt b/version.txt new file mode 100644 index 0000000..be12806 --- /dev/null +++ b/version.txt @@ -0,0 +1 @@ +0.1a
jsuchy/TddJavaScriptCodeCamp2009
4bf4c22037d6a955de7c0631df8a035c50d3c780
add code and slides
diff --git a/README b/README index e69de29..6d11612 100644 --- a/README +++ b/README @@ -0,0 +1,9 @@ +Code Camp Chicago - TDD and JavaScript + +This repo contains: + +slides/TddAndJavaScript.pdf => the slides from the presentation +code/* => the code written during the presentation + +The testing framework developed during the presentation can be found at http://github.com/jsuchy/JsSimpleUnit/tree/master. +This framework will have limited development by the author, but feel free to fork and play around with it. diff --git a/code/JsSImpleUnit.css b/code/JsSImpleUnit.css new file mode 100644 index 0000000..d2c4ff3 --- /dev/null +++ b/code/JsSImpleUnit.css @@ -0,0 +1,22 @@ +.test_result { + padding: 5px 10px 5px 10px; + background-color: #F5F4F3; + border: solid 1px #DDD; + margin: 0 0 2px 0; + width: 700px; + font-size: 16px; + color: #666; + line-height: 20px; +} + +.passed { + background-color: #EFD; + border-color: #BEA; + color: #593; +} + +.failed { + background-color: #FEE; + border-color: #FCC; + color: #C44; +} \ No newline at end of file diff --git a/code/boxes.html b/code/boxes.html new file mode 100644 index 0000000..edb7ff7 --- /dev/null +++ b/code/boxes.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html> + <head> + <title>Color Changer Example</title> + <script type="text/javascript" src="script/boxes.js"></script> + </head> + <body> + <div id="box" style="width: 400px; height: 400px; border: 1px solid; text-align: center;" + onclick="boxes.changeColor(document.getElementById('box'));"> + Click me! + </div> + </body> + +</html> \ No newline at end of file diff --git a/code/script/JsSimpleUnit.js b/code/script/JsSimpleUnit.js new file mode 100644 index 0000000..25c0b2a --- /dev/null +++ b/code/script/JsSimpleUnit.js @@ -0,0 +1,33 @@ +function test(tests) { + var passed = 0; + var failed = 0 ; + + function write(message, passed) { + var output = document.createElement("div"); + output.innerHTML = message; + output.className = "test_result"; + output.className += passed ? " passed" : " failed"; + document.body.appendChild(output); + } + + for (testName in tests) { + try { + tests[testName](); + write(testName + " passed", true); + passed++; + } + catch (ex) { + write(testName + " failed: " + ex.message, false); + failed++; + } + } + + write(passed + " tests passed", true); + write(failed + " tests failed", false); +} + +test.assertEquals = function(actualValue, expectedValue) { + if (actualValue !== expectedValue) { + throw new Error("Expected " + expectedValue + " but got " + actualValue); + } +} \ No newline at end of file diff --git a/code/script/boxes.js b/code/script/boxes.js new file mode 100644 index 0000000..0f939b1 --- /dev/null +++ b/code/script/boxes.js @@ -0,0 +1,8 @@ +var boxes = { + color: "green", + changeColor: function(element) { + this.color = this.color === "green" ? "red" : "green"; + + element.style.backgroundColor = this.color; + } +} \ No newline at end of file diff --git a/code/testJsSimpleUnit.html b/code/testJsSimpleUnit.html new file mode 100644 index 0000000..17608d3 --- /dev/null +++ b/code/testJsSimpleUnit.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html> + <head> + <title>Test JsSimpleUnit functionality</title> + <script type="text/javascript" src="script/JsSimpleUnit.js"></script> + <link href="JsSimpleUnit.css" rel="stylesheet" type="text/css"> + </head> + <body> + <h2>JsSimpleUnit Test Suite</h2> + </body> + + <script type="text/javascript"> + // jssu 1-4 + test({ + alwaysPassingTest: function() { + var i; + }, + alwaysFailingTest: function() { + throw new Error("Always fails"); + }, + testAssertEqualsWorks: function() { + test.assertEquals(1, 1); + }, + testAssertEqualsShouldFail: function() { + test.assertEquals(1, 2); + }, + + + }); + </script> +</html> diff --git a/code/test_boxes.html b/code/test_boxes.html new file mode 100644 index 0000000..d72f1c3 --- /dev/null +++ b/code/test_boxes.html @@ -0,0 +1,36 @@ +<html> + <head> + <title>Test boxes</title> + <link href="JsSimpleUnit.css" rel="stylesheet" type="text/css"> + <script type="text/javascript" src="script/JsSimpleUnit.js"></script> + <script type="text/javascript" src="script/boxes.js"></script> + </head> + <body> + <h2>Boxes Test Suite</h2> + </body> + + <script type="text/javascript"> + // box 1-3 + test({ + initialColorIsGreen: function() { + test.assertEquals(boxes.color, "green"); + }, + changesColorFromGreen: function() { + boxes.color = "green"; + var element = document.createElement("div"); + + boxes.changeColor(element); + + test.assertEquals(element.style.backgroundColor, "red"); + }, + changesColorFromRed: function() { + boxes.color = "red"; + var element = document.createElement("div"); + + boxes.changeColor(element); + + test.assertEquals(element.style.backgroundColor, "green"); + }, + }); + </script> +</html> \ No newline at end of file diff --git a/slides/TddAndJavascript.pdf b/slides/TddAndJavascript.pdf new file mode 100644 index 0000000..f5a39f2 Binary files /dev/null and b/slides/TddAndJavascript.pdf differ
jsuchy/TddJavaScriptCodeCamp2009
ac654f1b93f998d035533d186c77ba2ba12dc067
empty repo
diff --git a/README b/README new file mode 100644 index 0000000..e69de29
aparrish/sexywindsurfing
3b45ccb872bcfbbef99a02b20029daf21fc074aa
another commit
diff --git a/.Agent.py.swp b/.Agent.py.swp new file mode 100644 index 0000000..59e1416 Binary files /dev/null and b/.Agent.py.swp differ diff --git a/Agent.py b/Agent.py new file mode 100644 index 0000000..138bb92 --- /dev/null +++ b/Agent.py @@ -0,0 +1,89 @@ + +class Agent(object): + + def __init__(self): + self.hand = set() + self.hand_history = list() + + def play(self, card): + self.hand_history.append(self.hand.copy()) + self.hand.remove(card) + + def deal(self, card): + self.hand.add(card) + + def pick(self, target, criterion): + card = criterion.pick(target, self.hand) + return card + +class Criterion(object): + + def pick(self, target, sources): + from random import choice + return choice(list(sources)) + +class GoogleCriterion(object): + + def __init__(self): + self.counter = GoogleAjaxSearchCounter() + + def pick(self, target, sources): + + scores = dict() + for src in sources: + source_count = self.counter.get_count('"%s"' % src) + source_target_count = self.counter.get_count('%s "%s"' % (target, src)) + print 'count for "%s": %s' % (src, source_count) + print 'count for %s "%s": %s' % (target, src, source_target_count) + scores[src] = float(source_target_count) / float(source_count) + + return self.choose_best(scores) + +class GoogleHighestCriterion(GoogleCriterion): + + def choose_best(self, scores): + import operator + s = sorted(scores.iteritems(), key=operator.itemgetter(1), reverse=True) + return s[0] + +class GoogleAjaxSearchCounter(object): + + url_base = 'http://ajax.googleapis.com/ajax/services/search/web?v=1.0&q=' + referrer = 'http://www.decontextualize.com/' + + def __init__(self): + self.cache = dict() + + def get_count(self, term): + import urllib2 + import urllib + import json + from time import sleep + + if term in self.cache: + return self.cache[term] + + url = self.url_base + urllib.quote(term) + print url + request = urllib2.Request(url, None, {'Referer': self.referrer}) + response = urllib2.urlopen(request) + + results = json.load(response) + print results + count = results['responseData']['cursor']['estimatedResultCount'] + self.cache[term] = count + + sleep(0.25) + + return count + +if __name__ == '__main__': + + agent = Agent() + for card in ['friction', 'firefighters', 'george washington']: + agent.deal(card) + + card = agent.pick('temperamental', GoogleHighestCriterion()) + + print card + diff --git a/xgoogle/BeautifulSoup.py b/xgoogle/BeautifulSoup.py new file mode 100755 index 0000000..0e55aba --- /dev/null +++ b/xgoogle/BeautifulSoup.py @@ -0,0 +1,1931 @@ +"""Beautiful Soup +Elixir and Tonic +"The Screen-Scraper's Friend" +http://www.crummy.com/software/BeautifulSoup/ + +Beautiful Soup parses a (possibly invalid) XML or HTML document into a +tree representation. It provides methods and Pythonic idioms that make +it easy to navigate, search, and modify the tree. + +A well-formed XML/HTML document yields a well-formed data +structure. An ill-formed XML/HTML document yields a correspondingly +ill-formed data structure. If your document is only locally +well-formed, you can use this library to find and process the +well-formed part of it. + +Beautiful Soup works with Python 2.2 and up. It has no external +dependencies, but you'll have more success at converting data to UTF-8 +if you also install these three packages: + +* chardet, for auto-detecting character encodings + http://chardet.feedparser.org/ +* cjkcodecs and iconv_codec, which add more encodings to the ones supported + by stock Python. + http://cjkpython.i18n.org/ + +Beautiful Soup defines classes for two main parsing strategies: + + * BeautifulStoneSoup, for parsing XML, SGML, or your domain-specific + language that kind of looks like XML. + + * BeautifulSoup, for parsing run-of-the-mill HTML code, be it valid + or invalid. This class has web browser-like heuristics for + obtaining a sensible parse tree in the face of common HTML errors. + +Beautiful Soup also defines a class (UnicodeDammit) for autodetecting +the encoding of an HTML or XML document, and converting it to +Unicode. Much of this code is taken from Mark Pilgrim's Universal Feed Parser. + +For more than you ever wanted to know about Beautiful Soup, see the +documentation: +http://www.crummy.com/software/BeautifulSoup/documentation.html + +Here, have some legalese: + +Copyright (c) 2004-2007, Leonard Richardson + +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + * Neither the name of the the Beautiful Soup Consortium and All + Night Kosher Bakery nor the names of its contributors may be + used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE, DAMMIT. + +""" +from __future__ import generators + +__author__ = "Leonard Richardson ([email protected])" +__version__ = "3.0.6" +__copyright__ = "Copyright (c) 2004-2008 Leonard Richardson" +__license__ = "New-style BSD" + +from sgmllib import SGMLParser, SGMLParseError +import codecs +import types +import re +import sgmllib +try: + from htmlentitydefs import name2codepoint +except ImportError: + name2codepoint = {} + +#This hack makes Beautiful Soup able to parse XML with namespaces +sgmllib.tagfind = re.compile('[a-zA-Z][-_.:a-zA-Z0-9]*') + +DEFAULT_OUTPUT_ENCODING = "utf-8" + +# First, the classes that represent markup elements. + +class PageElement: + """Contains the navigational information for some part of the page + (either a tag or a piece of text)""" + + def setup(self, parent=None, previous=None): + """Sets up the initial relations between this element and + other elements.""" + self.parent = parent + self.previous = previous + self.next = None + self.previousSibling = None + self.nextSibling = None + if self.parent and self.parent.contents: + self.previousSibling = self.parent.contents[-1] + self.previousSibling.nextSibling = self + + def replaceWith(self, replaceWith): + oldParent = self.parent + myIndex = self.parent.contents.index(self) + if hasattr(replaceWith, 'parent') and replaceWith.parent == self.parent: + # We're replacing this element with one of its siblings. + index = self.parent.contents.index(replaceWith) + if index and index < myIndex: + # Furthermore, it comes before this element. That + # means that when we extract it, the index of this + # element will change. + myIndex = myIndex - 1 + self.extract() + oldParent.insert(myIndex, replaceWith) + + def extract(self): + """Destructively rips this element out of the tree.""" + if self.parent: + try: + self.parent.contents.remove(self) + except ValueError: + pass + + #Find the two elements that would be next to each other if + #this element (and any children) hadn't been parsed. Connect + #the two. + lastChild = self._lastRecursiveChild() + nextElement = lastChild.next + + if self.previous: + self.previous.next = nextElement + if nextElement: + nextElement.previous = self.previous + self.previous = None + lastChild.next = None + + self.parent = None + if self.previousSibling: + self.previousSibling.nextSibling = self.nextSibling + if self.nextSibling: + self.nextSibling.previousSibling = self.previousSibling + self.previousSibling = self.nextSibling = None + return self + + def _lastRecursiveChild(self): + "Finds the last element beneath this object to be parsed." + lastChild = self + while hasattr(lastChild, 'contents') and lastChild.contents: + lastChild = lastChild.contents[-1] + return lastChild + + def insert(self, position, newChild): + if (isinstance(newChild, basestring) + or isinstance(newChild, unicode)) \ + and not isinstance(newChild, NavigableString): + newChild = NavigableString(newChild) + + position = min(position, len(self.contents)) + if hasattr(newChild, 'parent') and newChild.parent != None: + # We're 'inserting' an element that's already one + # of this object's children. + if newChild.parent == self: + index = self.find(newChild) + if index and index < position: + # Furthermore we're moving it further down the + # list of this object's children. That means that + # when we extract this element, our target index + # will jump down one. + position = position - 1 + newChild.extract() + + newChild.parent = self + previousChild = None + if position == 0: + newChild.previousSibling = None + newChild.previous = self + else: + previousChild = self.contents[position-1] + newChild.previousSibling = previousChild + newChild.previousSibling.nextSibling = newChild + newChild.previous = previousChild._lastRecursiveChild() + if newChild.previous: + newChild.previous.next = newChild + + newChildsLastElement = newChild._lastRecursiveChild() + + if position >= len(self.contents): + newChild.nextSibling = None + + parent = self + parentsNextSibling = None + while not parentsNextSibling: + parentsNextSibling = parent.nextSibling + parent = parent.parent + if not parent: # This is the last element in the document. + break + if parentsNextSibling: + newChildsLastElement.next = parentsNextSibling + else: + newChildsLastElement.next = None + else: + nextChild = self.contents[position] + newChild.nextSibling = nextChild + if newChild.nextSibling: + newChild.nextSibling.previousSibling = newChild + newChildsLastElement.next = nextChild + + if newChildsLastElement.next: + newChildsLastElement.next.previous = newChildsLastElement + self.contents.insert(position, newChild) + + def append(self, tag): + """Appends the given tag to the contents of this tag.""" + self.insert(len(self.contents), tag) + + def findNext(self, name=None, attrs={}, text=None, **kwargs): + """Returns the first item that matches the given criteria and + appears after this Tag in the document.""" + return self._findOne(self.findAllNext, name, attrs, text, **kwargs) + + def findAllNext(self, name=None, attrs={}, text=None, limit=None, + **kwargs): + """Returns all items that match the given criteria and appear + after this Tag in the document.""" + return self._findAll(name, attrs, text, limit, self.nextGenerator, + **kwargs) + + def findNextSibling(self, name=None, attrs={}, text=None, **kwargs): + """Returns the closest sibling to this Tag that matches the + given criteria and appears after this Tag in the document.""" + return self._findOne(self.findNextSiblings, name, attrs, text, + **kwargs) + + def findNextSiblings(self, name=None, attrs={}, text=None, limit=None, + **kwargs): + """Returns the siblings of this Tag that match the given + criteria and appear after this Tag in the document.""" + return self._findAll(name, attrs, text, limit, + self.nextSiblingGenerator, **kwargs) + fetchNextSiblings = findNextSiblings # Compatibility with pre-3.x + + def findPrevious(self, name=None, attrs={}, text=None, **kwargs): + """Returns the first item that matches the given criteria and + appears before this Tag in the document.""" + return self._findOne(self.findAllPrevious, name, attrs, text, **kwargs) + + def findAllPrevious(self, name=None, attrs={}, text=None, limit=None, + **kwargs): + """Returns all items that match the given criteria and appear + before this Tag in the document.""" + return self._findAll(name, attrs, text, limit, self.previousGenerator, + **kwargs) + fetchPrevious = findAllPrevious # Compatibility with pre-3.x + + def findPreviousSibling(self, name=None, attrs={}, text=None, **kwargs): + """Returns the closest sibling to this Tag that matches the + given criteria and appears before this Tag in the document.""" + return self._findOne(self.findPreviousSiblings, name, attrs, text, + **kwargs) + + def findPreviousSiblings(self, name=None, attrs={}, text=None, + limit=None, **kwargs): + """Returns the siblings of this Tag that match the given + criteria and appear before this Tag in the document.""" + return self._findAll(name, attrs, text, limit, + self.previousSiblingGenerator, **kwargs) + fetchPreviousSiblings = findPreviousSiblings # Compatibility with pre-3.x + + def findParent(self, name=None, attrs={}, **kwargs): + """Returns the closest parent of this Tag that matches the given + criteria.""" + # NOTE: We can't use _findOne because findParents takes a different + # set of arguments. + r = None + l = self.findParents(name, attrs, 1) + if l: + r = l[0] + return r + + def findParents(self, name=None, attrs={}, limit=None, **kwargs): + """Returns the parents of this Tag that match the given + criteria.""" + + return self._findAll(name, attrs, None, limit, self.parentGenerator, + **kwargs) + fetchParents = findParents # Compatibility with pre-3.x + + #These methods do the real heavy lifting. + + def _findOne(self, method, name, attrs, text, **kwargs): + r = None + l = method(name, attrs, text, 1, **kwargs) + if l: + r = l[0] + return r + + def _findAll(self, name, attrs, text, limit, generator, **kwargs): + "Iterates over a generator looking for things that match." + + if isinstance(name, SoupStrainer): + strainer = name + else: + # Build a SoupStrainer + strainer = SoupStrainer(name, attrs, text, **kwargs) + results = ResultSet(strainer) + g = generator() + while True: + try: + i = g.next() + except StopIteration: + break + if i: + found = strainer.search(i) + if found: + results.append(found) + if limit and len(results) >= limit: + break + return results + + #These Generators can be used to navigate starting from both + #NavigableStrings and Tags. + def nextGenerator(self): + i = self + while i: + i = i.next + yield i + + def nextSiblingGenerator(self): + i = self + while i: + i = i.nextSibling + yield i + + def previousGenerator(self): + i = self + while i: + i = i.previous + yield i + + def previousSiblingGenerator(self): + i = self + while i: + i = i.previousSibling + yield i + + def parentGenerator(self): + i = self + while i: + i = i.parent + yield i + + # Utility methods + def substituteEncoding(self, str, encoding=None): + encoding = encoding or "utf-8" + return str.replace("%SOUP-ENCODING%", encoding) + + def toEncoding(self, s, encoding=None): + """Encodes an object to a string in some encoding, or to Unicode. + .""" + if isinstance(s, unicode): + if encoding: + s = s.encode(encoding) + elif isinstance(s, str): + if encoding: + s = s.encode(encoding) + else: + s = unicode(s) + else: + if encoding: + s = self.toEncoding(str(s), encoding) + else: + s = unicode(s) + return s + +class NavigableString(unicode, PageElement): + + def __getnewargs__(self): + return (NavigableString.__str__(self),) + + def __getattr__(self, attr): + """text.string gives you text. This is for backwards + compatibility for Navigable*String, but for CData* it lets you + get the string without the CData wrapper.""" + if attr == 'string': + return self + else: + raise AttributeError, "'%s' object has no attribute '%s'" % (self.__class__.__name__, attr) + + def __unicode__(self): + return str(self).decode(DEFAULT_OUTPUT_ENCODING) + + def __str__(self, encoding=DEFAULT_OUTPUT_ENCODING): + if encoding: + return self.encode(encoding) + else: + return self + +class CData(NavigableString): + + def __str__(self, encoding=DEFAULT_OUTPUT_ENCODING): + return "<![CDATA[%s]]>" % NavigableString.__str__(self, encoding) + +class ProcessingInstruction(NavigableString): + def __str__(self, encoding=DEFAULT_OUTPUT_ENCODING): + output = self + if "%SOUP-ENCODING%" in output: + output = self.substituteEncoding(output, encoding) + return "<?%s?>" % self.toEncoding(output, encoding) + +class Comment(NavigableString): + def __str__(self, encoding=DEFAULT_OUTPUT_ENCODING): + return "<!--%s-->" % NavigableString.__str__(self, encoding) + +class Declaration(NavigableString): + def __str__(self, encoding=DEFAULT_OUTPUT_ENCODING): + return "<!%s>" % NavigableString.__str__(self, encoding) + +class Tag(PageElement): + + """Represents a found HTML tag with its attributes and contents.""" + + def _invert(h): + "Cheap function to invert a hash." + i = {} + for k,v in h.items(): + i[v] = k + return i + + XML_ENTITIES_TO_SPECIAL_CHARS = { "apos" : "'", + "quot" : '"', + "amp" : "&", + "lt" : "<", + "gt" : ">" } + + XML_SPECIAL_CHARS_TO_ENTITIES = _invert(XML_ENTITIES_TO_SPECIAL_CHARS) + + def _convertEntities(self, match): + """Used in a call to re.sub to replace HTML, XML, and numeric + entities with the appropriate Unicode characters. If HTML + entities are being converted, any unrecognized entities are + escaped.""" + x = match.group(1) + if self.convertHTMLEntities and x in name2codepoint: + return unichr(name2codepoint[x]) + elif x in self.XML_ENTITIES_TO_SPECIAL_CHARS: + if self.convertXMLEntities: + return self.XML_ENTITIES_TO_SPECIAL_CHARS[x] + else: + return u'&%s;' % x + elif len(x) > 0 and x[0] == '#': + # Handle numeric entities + if len(x) > 1 and x[1] == 'x': + return unichr(int(x[2:], 16)) + else: + return unichr(int(x[1:])) + + elif self.escapeUnrecognizedEntities: + return u'&amp;%s;' % x + else: + return u'&%s;' % x + + def __init__(self, parser, name, attrs=None, parent=None, + previous=None): + "Basic constructor." + + # We don't actually store the parser object: that lets extracted + # chunks be garbage-collected + self.parserClass = parser.__class__ + self.isSelfClosing = parser.isSelfClosingTag(name) + self.name = name + if attrs == None: + attrs = [] + self.attrs = attrs + self.contents = [] + self.setup(parent, previous) + self.hidden = False + self.containsSubstitutions = False + self.convertHTMLEntities = parser.convertHTMLEntities + self.convertXMLEntities = parser.convertXMLEntities + self.escapeUnrecognizedEntities = parser.escapeUnrecognizedEntities + + # Convert any HTML, XML, or numeric entities in the attribute values. + convert = lambda(k, val): (k, + re.sub("&(#\d+|#x[0-9a-fA-F]+|\w+);", + self._convertEntities, + val)) + self.attrs = map(convert, self.attrs) + + def get(self, key, default=None): + """Returns the value of the 'key' attribute for the tag, or + the value given for 'default' if it doesn't have that + attribute.""" + return self._getAttrMap().get(key, default) + + def has_key(self, key): + return self._getAttrMap().has_key(key) + + def __getitem__(self, key): + """tag[key] returns the value of the 'key' attribute for the tag, + and throws an exception if it's not there.""" + return self._getAttrMap()[key] + + def __iter__(self): + "Iterating over a tag iterates over its contents." + return iter(self.contents) + + def __len__(self): + "The length of a tag is the length of its list of contents." + return len(self.contents) + + def __contains__(self, x): + return x in self.contents + + def __nonzero__(self): + "A tag is non-None even if it has no contents." + return True + + def __setitem__(self, key, value): + """Setting tag[key] sets the value of the 'key' attribute for the + tag.""" + self._getAttrMap() + self.attrMap[key] = value + found = False + for i in range(0, len(self.attrs)): + if self.attrs[i][0] == key: + self.attrs[i] = (key, value) + found = True + if not found: + self.attrs.append((key, value)) + self._getAttrMap()[key] = value + + def __delitem__(self, key): + "Deleting tag[key] deletes all 'key' attributes for the tag." + for item in self.attrs: + if item[0] == key: + self.attrs.remove(item) + #We don't break because bad HTML can define the same + #attribute multiple times. + self._getAttrMap() + if self.attrMap.has_key(key): + del self.attrMap[key] + + def __call__(self, *args, **kwargs): + """Calling a tag like a function is the same as calling its + findAll() method. Eg. tag('a') returns a list of all the A tags + found within this tag.""" + return apply(self.findAll, args, kwargs) + + def __getattr__(self, tag): + #print "Getattr %s.%s" % (self.__class__, tag) + if len(tag) > 3 and tag.rfind('Tag') == len(tag)-3: + return self.find(tag[:-3]) + elif tag.find('__') != 0: + return self.find(tag) + raise AttributeError, "'%s' object has no attribute '%s'" % (self.__class__, tag) + + def __eq__(self, other): + """Returns true iff this tag has the same name, the same attributes, + and the same contents (recursively) as the given tag. + + NOTE: right now this will return false if two tags have the + same attributes in a different order. Should this be fixed?""" + if not hasattr(other, 'name') or not hasattr(other, 'attrs') or not hasattr(other, 'contents') or self.name != other.name or self.attrs != other.attrs or len(self) != len(other): + return False + for i in range(0, len(self.contents)): + if self.contents[i] != other.contents[i]: + return False + return True + + def __ne__(self, other): + """Returns true iff this tag is not identical to the other tag, + as defined in __eq__.""" + return not self == other + + def __repr__(self, encoding=DEFAULT_OUTPUT_ENCODING): + """Renders this tag as a string.""" + return self.__str__(encoding) + + def __unicode__(self): + return self.__str__(None) + + BARE_AMPERSAND_OR_BRACKET = re.compile("([<>]|" + + "&(?!#\d+;|#x[0-9a-fA-F]+;|\w+;)" + + ")") + + def _sub_entity(self, x): + """Used with a regular expression to substitute the + appropriate XML entity for an XML special character.""" + return "&" + self.XML_SPECIAL_CHARS_TO_ENTITIES[x.group(0)[0]] + ";" + + def __str__(self, encoding=DEFAULT_OUTPUT_ENCODING, + prettyPrint=False, indentLevel=0): + """Returns a string or Unicode representation of this tag and + its contents. To get Unicode, pass None for encoding. + + NOTE: since Python's HTML parser consumes whitespace, this + method is not certain to reproduce the whitespace present in + the original string.""" + + encodedName = self.toEncoding(self.name, encoding) + + attrs = [] + if self.attrs: + for key, val in self.attrs: + fmt = '%s="%s"' + if isString(val): + if self.containsSubstitutions and '%SOUP-ENCODING%' in val: + val = self.substituteEncoding(val, encoding) + + # The attribute value either: + # + # * Contains no embedded double quotes or single quotes. + # No problem: we enclose it in double quotes. + # * Contains embedded single quotes. No problem: + # double quotes work here too. + # * Contains embedded double quotes. No problem: + # we enclose it in single quotes. + # * Embeds both single _and_ double quotes. This + # can't happen naturally, but it can happen if + # you modify an attribute value after parsing + # the document. Now we have a bit of a + # problem. We solve it by enclosing the + # attribute in single quotes, and escaping any + # embedded single quotes to XML entities. + if '"' in val: + fmt = "%s='%s'" + if "'" in val: + # TODO: replace with apos when + # appropriate. + val = val.replace("'", "&squot;") + + # Now we're okay w/r/t quotes. But the attribute + # value might also contain angle brackets, or + # ampersands that aren't part of entities. We need + # to escape those to XML entities too. + val = self.BARE_AMPERSAND_OR_BRACKET.sub(self._sub_entity, val) + + attrs.append(fmt % (self.toEncoding(key, encoding), + self.toEncoding(val, encoding))) + close = '' + closeTag = '' + if self.isSelfClosing: + close = ' /' + else: + closeTag = '</%s>' % encodedName + + indentTag, indentContents = 0, 0 + if prettyPrint: + indentTag = indentLevel + space = (' ' * (indentTag-1)) + indentContents = indentTag + 1 + contents = self.renderContents(encoding, prettyPrint, indentContents) + if self.hidden: + s = contents + else: + s = [] + attributeString = '' + if attrs: + attributeString = ' ' + ' '.join(attrs) + if prettyPrint: + s.append(space) + s.append('<%s%s%s>' % (encodedName, attributeString, close)) + if prettyPrint: + s.append("\n") + s.append(contents) + if prettyPrint and contents and contents[-1] != "\n": + s.append("\n") + if prettyPrint and closeTag: + s.append(space) + s.append(closeTag) + if prettyPrint and closeTag and self.nextSibling: + s.append("\n") + s = ''.join(s) + return s + + def decompose(self): + """Recursively destroys the contents of this tree.""" + contents = [i for i in self.contents] + for i in contents: + if isinstance(i, Tag): + i.decompose() + else: + i.extract() + self.extract() + + def prettify(self, encoding=DEFAULT_OUTPUT_ENCODING): + return self.__str__(encoding, True) + + def renderContents(self, encoding=DEFAULT_OUTPUT_ENCODING, + prettyPrint=False, indentLevel=0): + """Renders the contents of this tag as a string in the given + encoding. If encoding is None, returns a Unicode string..""" + s=[] + for c in self: + text = None + if isinstance(c, NavigableString): + text = c.__str__(encoding) + elif isinstance(c, Tag): + s.append(c.__str__(encoding, prettyPrint, indentLevel)) + if text and prettyPrint: + text = text.strip() + if text: + if prettyPrint: + s.append(" " * (indentLevel-1)) + s.append(text) + if prettyPrint: + s.append("\n") + return ''.join(s) + + #Soup methods + + def find(self, name=None, attrs={}, recursive=True, text=None, + **kwargs): + """Return only the first child of this Tag matching the given + criteria.""" + r = None + l = self.findAll(name, attrs, recursive, text, 1, **kwargs) + if l: + r = l[0] + return r + findChild = find + + def findAll(self, name=None, attrs={}, recursive=True, text=None, + limit=None, **kwargs): + """Extracts a list of Tag objects that match the given + criteria. You can specify the name of the Tag and any + attributes you want the Tag to have. + + The value of a key-value pair in the 'attrs' map can be a + string, a list of strings, a regular expression object, or a + callable that takes a string and returns whether or not the + string matches for some custom definition of 'matches'. The + same is true of the tag name.""" + generator = self.recursiveChildGenerator + if not recursive: + generator = self.childGenerator + return self._findAll(name, attrs, text, limit, generator, **kwargs) + findChildren = findAll + + # Pre-3.x compatibility methods + first = find + fetch = findAll + + def fetchText(self, text=None, recursive=True, limit=None): + return self.findAll(text=text, recursive=recursive, limit=limit) + + def firstText(self, text=None, recursive=True): + return self.find(text=text, recursive=recursive) + + #Private methods + + def _getAttrMap(self): + """Initializes a map representation of this tag's attributes, + if not already initialized.""" + if not getattr(self, 'attrMap'): + self.attrMap = {} + for (key, value) in self.attrs: + self.attrMap[key] = value + return self.attrMap + + #Generator methods + def childGenerator(self): + for i in range(0, len(self.contents)): + yield self.contents[i] + raise StopIteration + + def recursiveChildGenerator(self): + stack = [(self, 0)] + while stack: + tag, start = stack.pop() + if isinstance(tag, Tag): + for i in range(start, len(tag.contents)): + a = tag.contents[i] + yield a + if isinstance(a, Tag) and tag.contents: + if i < len(tag.contents) - 1: + stack.append((tag, i+1)) + stack.append((a, 0)) + break + raise StopIteration + +# Next, a couple classes to represent queries and their results. +class SoupStrainer: + """Encapsulates a number of ways of matching a markup element (tag or + text).""" + + def __init__(self, name=None, attrs={}, text=None, **kwargs): + self.name = name + if isString(attrs): + kwargs['class'] = attrs + attrs = None + if kwargs: + if attrs: + attrs = attrs.copy() + attrs.update(kwargs) + else: + attrs = kwargs + self.attrs = attrs + self.text = text + + def __str__(self): + if self.text: + return self.text + else: + return "%s|%s" % (self.name, self.attrs) + + def searchTag(self, markupName=None, markupAttrs={}): + found = None + markup = None + if isinstance(markupName, Tag): + markup = markupName + markupAttrs = markup + callFunctionWithTagData = callable(self.name) \ + and not isinstance(markupName, Tag) + + if (not self.name) \ + or callFunctionWithTagData \ + or (markup and self._matches(markup, self.name)) \ + or (not markup and self._matches(markupName, self.name)): + if callFunctionWithTagData: + match = self.name(markupName, markupAttrs) + else: + match = True + markupAttrMap = None + for attr, matchAgainst in self.attrs.items(): + if not markupAttrMap: + if hasattr(markupAttrs, 'get'): + markupAttrMap = markupAttrs + else: + markupAttrMap = {} + for k,v in markupAttrs: + markupAttrMap[k] = v + attrValue = markupAttrMap.get(attr) + if not self._matches(attrValue, matchAgainst): + match = False + break + if match: + if markup: + found = markup + else: + found = markupName + return found + + def search(self, markup): + #print 'looking for %s in %s' % (self, markup) + found = None + # If given a list of items, scan it for a text element that + # matches. + if isList(markup) and not isinstance(markup, Tag): + for element in markup: + if isinstance(element, NavigableString) \ + and self.search(element): + found = element + break + # If it's a Tag, make sure its name or attributes match. + # Don't bother with Tags if we're searching for text. + elif isinstance(markup, Tag): + if not self.text: + found = self.searchTag(markup) + # If it's text, make sure the text matches. + elif isinstance(markup, NavigableString) or \ + isString(markup): + if self._matches(markup, self.text): + found = markup + else: + raise Exception, "I don't know how to match against a %s" \ + % markup.__class__ + return found + + def _matches(self, markup, matchAgainst): + #print "Matching %s against %s" % (markup, matchAgainst) + result = False + if matchAgainst == True and type(matchAgainst) == types.BooleanType: + result = markup != None + elif callable(matchAgainst): + result = matchAgainst(markup) + else: + #Custom match methods take the tag as an argument, but all + #other ways of matching match the tag name as a string. + if isinstance(markup, Tag): + markup = markup.name + if markup and not isString(markup): + markup = unicode(markup) + #Now we know that chunk is either a string, or None. + if hasattr(matchAgainst, 'match'): + # It's a regexp object. + result = markup and matchAgainst.search(markup) + elif isList(matchAgainst): + result = markup in matchAgainst + elif hasattr(matchAgainst, 'items'): + result = markup.has_key(matchAgainst) + elif matchAgainst and isString(markup): + if isinstance(markup, unicode): + matchAgainst = unicode(matchAgainst) + else: + matchAgainst = str(matchAgainst) + + if not result: + result = matchAgainst == markup + return result + +class ResultSet(list): + """A ResultSet is just a list that keeps track of the SoupStrainer + that created it.""" + def __init__(self, source): + list.__init__([]) + self.source = source + +# Now, some helper functions. + +def isList(l): + """Convenience method that works with all 2.x versions of Python + to determine whether or not something is listlike.""" + return hasattr(l, '__iter__') \ + or (type(l) in (types.ListType, types.TupleType)) + +def isString(s): + """Convenience method that works with all 2.x versions of Python + to determine whether or not something is stringlike.""" + try: + return isinstance(s, unicode) or isinstance(s, basestring) + except NameError: + return isinstance(s, str) + +def buildTagMap(default, *args): + """Turns a list of maps, lists, or scalars into a single map. + Used to build the SELF_CLOSING_TAGS, NESTABLE_TAGS, and + NESTING_RESET_TAGS maps out of lists and partial maps.""" + built = {} + for portion in args: + if hasattr(portion, 'items'): + #It's a map. Merge it. + for k,v in portion.items(): + built[k] = v + elif isList(portion): + #It's a list. Map each item to the default. + for k in portion: + built[k] = default + else: + #It's a scalar. Map it to the default. + built[portion] = default + return built + +# Now, the parser classes. + +class BeautifulStoneSoup(Tag, SGMLParser): + + """This class contains the basic parser and search code. It defines + a parser that knows nothing about tag behavior except for the + following: + + You can't close a tag without closing all the tags it encloses. + That is, "<foo><bar></foo>" actually means + "<foo><bar></bar></foo>". + + [Another possible explanation is "<foo><bar /></foo>", but since + this class defines no SELF_CLOSING_TAGS, it will never use that + explanation.] + + This class is useful for parsing XML or made-up markup languages, + or when BeautifulSoup makes an assumption counter to what you were + expecting.""" + + SELF_CLOSING_TAGS = {} + NESTABLE_TAGS = {} + RESET_NESTING_TAGS = {} + QUOTE_TAGS = {} + + MARKUP_MASSAGE = [(re.compile('(<[^<>]*)/>'), + lambda x: x.group(1) + ' />'), + (re.compile('<!\s+([^<>]*)>'), + lambda x: '<!' + x.group(1) + '>') + ] + + ROOT_TAG_NAME = u'[document]' + + HTML_ENTITIES = "html" + XML_ENTITIES = "xml" + XHTML_ENTITIES = "xhtml" + # TODO: This only exists for backwards-compatibility + ALL_ENTITIES = XHTML_ENTITIES + + # Used when determining whether a text node is all whitespace and + # can be replaced with a single space. A text node that contains + # fancy Unicode spaces (usually non-breaking) should be left + # alone. + STRIP_ASCII_SPACES = { 9: None, 10: None, 12: None, 13: None, 32: None, } + + def __init__(self, markup="", parseOnlyThese=None, fromEncoding=None, + markupMassage=True, smartQuotesTo=XML_ENTITIES, + convertEntities=None, selfClosingTags=None): + """The Soup object is initialized as the 'root tag', and the + provided markup (which can be a string or a file-like object) + is fed into the underlying parser. + + sgmllib will process most bad HTML, and the BeautifulSoup + class has some tricks for dealing with some HTML that kills + sgmllib, but Beautiful Soup can nonetheless choke or lose data + if your data uses self-closing tags or declarations + incorrectly. + + By default, Beautiful Soup uses regexes to sanitize input, + avoiding the vast majority of these problems. If the problems + don't apply to you, pass in False for markupMassage, and + you'll get better performance. + + The default parser massage techniques fix the two most common + instances of invalid HTML that choke sgmllib: + + <br/> (No space between name of closing tag and tag close) + <! --Comment--> (Extraneous whitespace in declaration) + + You can pass in a custom list of (RE object, replace method) + tuples to get Beautiful Soup to scrub your input the way you + want.""" + + self.parseOnlyThese = parseOnlyThese + self.fromEncoding = fromEncoding + self.smartQuotesTo = smartQuotesTo + self.convertEntities = convertEntities + # Set the rules for how we'll deal with the entities we + # encounter + if self.convertEntities: + # It doesn't make sense to convert encoded characters to + # entities even while you're converting entities to Unicode. + # Just convert it all to Unicode. + self.smartQuotesTo = None + if convertEntities == self.HTML_ENTITIES: + self.convertXMLEntities = False + self.convertHTMLEntities = True + self.escapeUnrecognizedEntities = True + elif convertEntities == self.XHTML_ENTITIES: + self.convertXMLEntities = True + self.convertHTMLEntities = True + self.escapeUnrecognizedEntities = False + elif convertEntities == self.XML_ENTITIES: + self.convertXMLEntities = True + self.convertHTMLEntities = False + self.escapeUnrecognizedEntities = False + else: + self.convertXMLEntities = False + self.convertHTMLEntities = False + self.escapeUnrecognizedEntities = False + + self.instanceSelfClosingTags = buildTagMap(None, selfClosingTags) + SGMLParser.__init__(self) + + if hasattr(markup, 'read'): # It's a file-type object. + markup = markup.read() + self.markup = markup + self.markupMassage = markupMassage + try: + self._feed() + except StopParsing: + pass + self.markup = None # The markup can now be GCed + + def convert_charref(self, name): + """This method fixes a bug in Python's SGMLParser.""" + try: + n = int(name) + except ValueError: + return + if not 0 <= n <= 127 : # ASCII ends at 127, not 255 + return + return self.convert_codepoint(n) + + def _feed(self, inDocumentEncoding=None): + # Convert the document to Unicode. + markup = self.markup + if isinstance(markup, unicode): + if not hasattr(self, 'originalEncoding'): + self.originalEncoding = None + else: + dammit = UnicodeDammit\ + (markup, [self.fromEncoding, inDocumentEncoding], + smartQuotesTo=self.smartQuotesTo) + markup = dammit.unicode + self.originalEncoding = dammit.originalEncoding + if markup: + if self.markupMassage: + if not isList(self.markupMassage): + self.markupMassage = self.MARKUP_MASSAGE + for fix, m in self.markupMassage: + markup = fix.sub(m, markup) + # TODO: We get rid of markupMassage so that the + # soup object can be deepcopied later on. Some + # Python installations can't copy regexes. If anyone + # was relying on the existence of markupMassage, this + # might cause problems. + del(self.markupMassage) + self.reset() + + SGMLParser.feed(self, markup) + # Close out any unfinished strings and close all the open tags. + self.endData() + while self.currentTag.name != self.ROOT_TAG_NAME: + self.popTag() + + def __getattr__(self, methodName): + """This method routes method call requests to either the SGMLParser + superclass or the Tag superclass, depending on the method name.""" + #print "__getattr__ called on %s.%s" % (self.__class__, methodName) + + if methodName.find('start_') == 0 or methodName.find('end_') == 0 \ + or methodName.find('do_') == 0: + return SGMLParser.__getattr__(self, methodName) + elif methodName.find('__') != 0: + return Tag.__getattr__(self, methodName) + else: + raise AttributeError + + def isSelfClosingTag(self, name): + """Returns true iff the given string is the name of a + self-closing tag according to this parser.""" + return self.SELF_CLOSING_TAGS.has_key(name) \ + or self.instanceSelfClosingTags.has_key(name) + + def reset(self): + Tag.__init__(self, self, self.ROOT_TAG_NAME) + self.hidden = 1 + SGMLParser.reset(self) + self.currentData = [] + self.currentTag = None + self.tagStack = [] + self.quoteStack = [] + self.pushTag(self) + + def popTag(self): + tag = self.tagStack.pop() + # Tags with just one string-owning child get the child as a + # 'string' property, so that soup.tag.string is shorthand for + # soup.tag.contents[0] + if len(self.currentTag.contents) == 1 and \ + isinstance(self.currentTag.contents[0], NavigableString): + self.currentTag.string = self.currentTag.contents[0] + + #print "Pop", tag.name + if self.tagStack: + self.currentTag = self.tagStack[-1] + return self.currentTag + + def pushTag(self, tag): + #print "Push", tag.name + if self.currentTag: + self.currentTag.contents.append(tag) + self.tagStack.append(tag) + self.currentTag = self.tagStack[-1] + + def endData(self, containerClass=NavigableString): + if self.currentData: + currentData = ''.join(self.currentData) + if not currentData.translate(self.STRIP_ASCII_SPACES): + if '\n' in currentData: + currentData = '\n' + else: + currentData = ' ' + self.currentData = [] + if self.parseOnlyThese and len(self.tagStack) <= 1 and \ + (not self.parseOnlyThese.text or \ + not self.parseOnlyThese.search(currentData)): + return + o = containerClass(currentData) + o.setup(self.currentTag, self.previous) + if self.previous: + self.previous.next = o + self.previous = o + self.currentTag.contents.append(o) + + + def _popToTag(self, name, inclusivePop=True): + """Pops the tag stack up to and including the most recent + instance of the given tag. If inclusivePop is false, pops the tag + stack up to but *not* including the most recent instqance of + the given tag.""" + #print "Popping to %s" % name + if name == self.ROOT_TAG_NAME: + return + + numPops = 0 + mostRecentTag = None + for i in range(len(self.tagStack)-1, 0, -1): + if name == self.tagStack[i].name: + numPops = len(self.tagStack)-i + break + if not inclusivePop: + numPops = numPops - 1 + + for i in range(0, numPops): + mostRecentTag = self.popTag() + return mostRecentTag + + def _smartPop(self, name): + + """We need to pop up to the previous tag of this type, unless + one of this tag's nesting reset triggers comes between this + tag and the previous tag of this type, OR unless this tag is a + generic nesting trigger and another generic nesting trigger + comes between this tag and the previous tag of this type. + + Examples: + <p>Foo<b>Bar *<p>* should pop to 'p', not 'b'. + <p>Foo<table>Bar *<p>* should pop to 'table', not 'p'. + <p>Foo<table><tr>Bar *<p>* should pop to 'tr', not 'p'. + + <li><ul><li> *<li>* should pop to 'ul', not the first 'li'. + <tr><table><tr> *<tr>* should pop to 'table', not the first 'tr' + <td><tr><td> *<td>* should pop to 'tr', not the first 'td' + """ + + nestingResetTriggers = self.NESTABLE_TAGS.get(name) + isNestable = nestingResetTriggers != None + isResetNesting = self.RESET_NESTING_TAGS.has_key(name) + popTo = None + inclusive = True + for i in range(len(self.tagStack)-1, 0, -1): + p = self.tagStack[i] + if (not p or p.name == name) and not isNestable: + #Non-nestable tags get popped to the top or to their + #last occurance. + popTo = name + break + if (nestingResetTriggers != None + and p.name in nestingResetTriggers) \ + or (nestingResetTriggers == None and isResetNesting + and self.RESET_NESTING_TAGS.has_key(p.name)): + + #If we encounter one of the nesting reset triggers + #peculiar to this tag, or we encounter another tag + #that causes nesting to reset, pop up to but not + #including that tag. + popTo = p.name + inclusive = False + break + p = p.parent + if popTo: + self._popToTag(popTo, inclusive) + + def unknown_starttag(self, name, attrs, selfClosing=0): + #print "Start tag %s: %s" % (name, attrs) + if self.quoteStack: + #This is not a real tag. + #print "<%s> is not real!" % name + attrs = ''.join(map(lambda(x, y): ' %s="%s"' % (x, y), attrs)) + self.handle_data('<%s%s>' % (name, attrs)) + return + self.endData() + + if not self.isSelfClosingTag(name) and not selfClosing: + self._smartPop(name) + + if self.parseOnlyThese and len(self.tagStack) <= 1 \ + and (self.parseOnlyThese.text or not self.parseOnlyThese.searchTag(name, attrs)): + return + + tag = Tag(self, name, attrs, self.currentTag, self.previous) + if self.previous: + self.previous.next = tag + self.previous = tag + self.pushTag(tag) + if selfClosing or self.isSelfClosingTag(name): + self.popTag() + if name in self.QUOTE_TAGS: + #print "Beginning quote (%s)" % name + self.quoteStack.append(name) + self.literal = 1 + return tag + + def unknown_endtag(self, name): + #print "End tag %s" % name + if self.quoteStack and self.quoteStack[-1] != name: + #This is not a real end tag. + #print "</%s> is not real!" % name + self.handle_data('</%s>' % name) + return + self.endData() + self._popToTag(name) + if self.quoteStack and self.quoteStack[-1] == name: + self.quoteStack.pop() + self.literal = (len(self.quoteStack) > 0) + + def handle_data(self, data): + self.currentData.append(data) + + def _toStringSubclass(self, text, subclass): + """Adds a certain piece of text to the tree as a NavigableString + subclass.""" + self.endData() + self.handle_data(text) + self.endData(subclass) + + def handle_pi(self, text): + """Handle a processing instruction as a ProcessingInstruction + object, possibly one with a %SOUP-ENCODING% slot into which an + encoding will be plugged later.""" + if text[:3] == "xml": + text = u"xml version='1.0' encoding='%SOUP-ENCODING%'" + self._toStringSubclass(text, ProcessingInstruction) + + def handle_comment(self, text): + "Handle comments as Comment objects." + self._toStringSubclass(text, Comment) + + def handle_charref(self, ref): + "Handle character references as data." + if self.convertEntities: + data = unichr(int(ref)) + else: + data = '&#%s;' % ref + self.handle_data(data) + + def handle_entityref(self, ref): + """Handle entity references as data, possibly converting known + HTML and/or XML entity references to the corresponding Unicode + characters.""" + data = None + if self.convertHTMLEntities: + try: + data = unichr(name2codepoint[ref]) + except KeyError: + pass + + if not data and self.convertXMLEntities: + data = self.XML_ENTITIES_TO_SPECIAL_CHARS.get(ref) + + if not data and self.convertHTMLEntities and \ + not self.XML_ENTITIES_TO_SPECIAL_CHARS.get(ref): + # TODO: We've got a problem here. We're told this is + # an entity reference, but it's not an XML entity + # reference or an HTML entity reference. Nonetheless, + # the logical thing to do is to pass it through as an + # unrecognized entity reference. + # + # Except: when the input is "&carol;" this function + # will be called with input "carol". When the input is + # "AT&T", this function will be called with input + # "T". We have no way of knowing whether a semicolon + # was present originally, so we don't know whether + # this is an unknown entity or just a misplaced + # ampersand. + # + # The more common case is a misplaced ampersand, so I + # escape the ampersand and omit the trailing semicolon. + data = "&amp;%s" % ref + if not data: + # This case is different from the one above, because we + # haven't already gone through a supposedly comprehensive + # mapping of entities to Unicode characters. We might not + # have gone through any mapping at all. So the chances are + # very high that this is a real entity, and not a + # misplaced ampersand. + data = "&%s;" % ref + self.handle_data(data) + + def handle_decl(self, data): + "Handle DOCTYPEs and the like as Declaration objects." + self._toStringSubclass(data, Declaration) + + def parse_declaration(self, i): + """Treat a bogus SGML declaration as raw data. Treat a CDATA + declaration as a CData object.""" + j = None + if self.rawdata[i:i+9] == '<![CDATA[': + k = self.rawdata.find(']]>', i) + if k == -1: + k = len(self.rawdata) + data = self.rawdata[i+9:k] + j = k+3 + self._toStringSubclass(data, CData) + else: + try: + j = SGMLParser.parse_declaration(self, i) + except SGMLParseError: + toHandle = self.rawdata[i:] + self.handle_data(toHandle) + j = i + len(toHandle) + return j + +class BeautifulSoup(BeautifulStoneSoup): + + """This parser knows the following facts about HTML: + + * Some tags have no closing tag and should be interpreted as being + closed as soon as they are encountered. + + * The text inside some tags (ie. 'script') may contain tags which + are not really part of the document and which should be parsed + as text, not tags. If you want to parse the text as tags, you can + always fetch it and parse it explicitly. + + * Tag nesting rules: + + Most tags can't be nested at all. For instance, the occurance of + a <p> tag should implicitly close the previous <p> tag. + + <p>Para1<p>Para2 + should be transformed into: + <p>Para1</p><p>Para2 + + Some tags can be nested arbitrarily. For instance, the occurance + of a <blockquote> tag should _not_ implicitly close the previous + <blockquote> tag. + + Alice said: <blockquote>Bob said: <blockquote>Blah + should NOT be transformed into: + Alice said: <blockquote>Bob said: </blockquote><blockquote>Blah + + Some tags can be nested, but the nesting is reset by the + interposition of other tags. For instance, a <tr> tag should + implicitly close the previous <tr> tag within the same <table>, + but not close a <tr> tag in another table. + + <table><tr>Blah<tr>Blah + should be transformed into: + <table><tr>Blah</tr><tr>Blah + but, + <tr>Blah<table><tr>Blah + should NOT be transformed into + <tr>Blah<table></tr><tr>Blah + + Differing assumptions about tag nesting rules are a major source + of problems with the BeautifulSoup class. If BeautifulSoup is not + treating as nestable a tag your page author treats as nestable, + try ICantBelieveItsBeautifulSoup, MinimalSoup, or + BeautifulStoneSoup before writing your own subclass.""" + + def __init__(self, *args, **kwargs): + if not kwargs.has_key('smartQuotesTo'): + kwargs['smartQuotesTo'] = self.HTML_ENTITIES + BeautifulStoneSoup.__init__(self, *args, **kwargs) + + SELF_CLOSING_TAGS = buildTagMap(None, + ['br' , 'hr', 'input', 'img', 'meta', + 'spacer', 'link', 'frame', 'base']) + + QUOTE_TAGS = {'script' : None, 'textarea' : None} + + #According to the HTML standard, each of these inline tags can + #contain another tag of the same type. Furthermore, it's common + #to actually use these tags this way. + NESTABLE_INLINE_TAGS = ['span', 'font', 'q', 'object', 'bdo', 'sub', 'sup', + 'center'] + + #According to the HTML standard, these block tags can contain + #another tag of the same type. Furthermore, it's common + #to actually use these tags this way. + NESTABLE_BLOCK_TAGS = ['blockquote', 'div', 'fieldset', 'ins', 'del'] + + #Lists can contain other lists, but there are restrictions. + NESTABLE_LIST_TAGS = { 'ol' : [], + 'ul' : [], + 'li' : ['ul', 'ol'], + 'dl' : [], + 'dd' : ['dl'], + 'dt' : ['dl'] } + + #Tables can contain other tables, but there are restrictions. + NESTABLE_TABLE_TAGS = {'table' : [], + 'tr' : ['table', 'tbody', 'tfoot', 'thead'], + 'td' : ['tr'], + 'th' : ['tr'], + 'thead' : ['table'], + 'tbody' : ['table'], + 'tfoot' : ['table'], + } + + NON_NESTABLE_BLOCK_TAGS = ['address', 'form', 'p', 'pre'] + + #If one of these tags is encountered, all tags up to the next tag of + #this type are popped. + RESET_NESTING_TAGS = buildTagMap(None, NESTABLE_BLOCK_TAGS, 'noscript', + NON_NESTABLE_BLOCK_TAGS, + NESTABLE_LIST_TAGS, + NESTABLE_TABLE_TAGS) + + NESTABLE_TAGS = buildTagMap([], NESTABLE_INLINE_TAGS, NESTABLE_BLOCK_TAGS, + NESTABLE_LIST_TAGS, NESTABLE_TABLE_TAGS) + + # Used to detect the charset in a META tag; see start_meta + CHARSET_RE = re.compile("((^|;)\s*charset=)([^;]*)") + + def start_meta(self, attrs): + """Beautiful Soup can detect a charset included in a META tag, + try to convert the document to that charset, and re-parse the + document from the beginning.""" + httpEquiv = None + contentType = None + contentTypeIndex = None + tagNeedsEncodingSubstitution = False + + for i in range(0, len(attrs)): + key, value = attrs[i] + key = key.lower() + if key == 'http-equiv': + httpEquiv = value + elif key == 'content': + contentType = value + contentTypeIndex = i + + if httpEquiv and contentType: # It's an interesting meta tag. + match = self.CHARSET_RE.search(contentType) + if match: + if getattr(self, 'declaredHTMLEncoding') or \ + (self.originalEncoding == self.fromEncoding): + # This is our second pass through the document, or + # else an encoding was specified explicitly and it + # worked. Rewrite the meta tag. + newAttr = self.CHARSET_RE.sub\ + (lambda(match):match.group(1) + + "%SOUP-ENCODING%", contentType) + attrs[contentTypeIndex] = (attrs[contentTypeIndex][0], + newAttr) + tagNeedsEncodingSubstitution = True + else: + # This is our first pass through the document. + # Go through it again with the new information. + newCharset = match.group(3) + if newCharset and newCharset != self.originalEncoding: + self.declaredHTMLEncoding = newCharset + self._feed(self.declaredHTMLEncoding) + raise StopParsing + tag = self.unknown_starttag("meta", attrs) + if tag and tagNeedsEncodingSubstitution: + tag.containsSubstitutions = True + +class StopParsing(Exception): + pass + +class ICantBelieveItsBeautifulSoup(BeautifulSoup): + + """The BeautifulSoup class is oriented towards skipping over + common HTML errors like unclosed tags. However, sometimes it makes + errors of its own. For instance, consider this fragment: + + <b>Foo<b>Bar</b></b> + + This is perfectly valid (if bizarre) HTML. However, the + BeautifulSoup class will implicitly close the first b tag when it + encounters the second 'b'. It will think the author wrote + "<b>Foo<b>Bar", and didn't close the first 'b' tag, because + there's no real-world reason to bold something that's already + bold. When it encounters '</b></b>' it will close two more 'b' + tags, for a grand total of three tags closed instead of two. This + can throw off the rest of your document structure. The same is + true of a number of other tags, listed below. + + It's much more common for someone to forget to close a 'b' tag + than to actually use nested 'b' tags, and the BeautifulSoup class + handles the common case. This class handles the not-co-common + case: where you can't believe someone wrote what they did, but + it's valid HTML and BeautifulSoup screwed up by assuming it + wouldn't be.""" + + I_CANT_BELIEVE_THEYRE_NESTABLE_INLINE_TAGS = \ + ['em', 'big', 'i', 'small', 'tt', 'abbr', 'acronym', 'strong', + 'cite', 'code', 'dfn', 'kbd', 'samp', 'strong', 'var', 'b', + 'big'] + + I_CANT_BELIEVE_THEYRE_NESTABLE_BLOCK_TAGS = ['noscript'] + + NESTABLE_TAGS = buildTagMap([], BeautifulSoup.NESTABLE_TAGS, + I_CANT_BELIEVE_THEYRE_NESTABLE_BLOCK_TAGS, + I_CANT_BELIEVE_THEYRE_NESTABLE_INLINE_TAGS) + +class MinimalSoup(BeautifulSoup): + """The MinimalSoup class is for parsing HTML that contains + pathologically bad markup. It makes no assumptions about tag + nesting, but it does know which tags are self-closing, that + <script> tags contain Javascript and should not be parsed, that + META tags may contain encoding information, and so on. + + This also makes it better for subclassing than BeautifulStoneSoup + or BeautifulSoup.""" + + RESET_NESTING_TAGS = buildTagMap('noscript') + NESTABLE_TAGS = {} + +class BeautifulSOAP(BeautifulStoneSoup): + """This class will push a tag with only a single string child into + the tag's parent as an attribute. The attribute's name is the tag + name, and the value is the string child. An example should give + the flavor of the change: + + <foo><bar>baz</bar></foo> + => + <foo bar="baz"><bar>baz</bar></foo> + + You can then access fooTag['bar'] instead of fooTag.barTag.string. + + This is, of course, useful for scraping structures that tend to + use subelements instead of attributes, such as SOAP messages. Note + that it modifies its input, so don't print the modified version + out. + + I'm not sure how many people really want to use this class; let me + know if you do. Mainly I like the name.""" + + def popTag(self): + if len(self.tagStack) > 1: + tag = self.tagStack[-1] + parent = self.tagStack[-2] + parent._getAttrMap() + if (isinstance(tag, Tag) and len(tag.contents) == 1 and + isinstance(tag.contents[0], NavigableString) and + not parent.attrMap.has_key(tag.name)): + parent[tag.name] = tag.contents[0] + BeautifulStoneSoup.popTag(self) + +#Enterprise class names! It has come to our attention that some people +#think the names of the Beautiful Soup parser classes are too silly +#and "unprofessional" for use in enterprise screen-scraping. We feel +#your pain! For such-minded folk, the Beautiful Soup Consortium And +#All-Night Kosher Bakery recommends renaming this file to +#"RobustParser.py" (or, in cases of extreme enterprisiness, +#"RobustParserBeanInterface.class") and using the following +#enterprise-friendly class aliases: +class RobustXMLParser(BeautifulStoneSoup): + pass +class RobustHTMLParser(BeautifulSoup): + pass +class RobustWackAssHTMLParser(ICantBelieveItsBeautifulSoup): + pass +class RobustInsanelyWackAssHTMLParser(MinimalSoup): + pass +class SimplifyingSOAPParser(BeautifulSOAP): + pass + +###################################################### +# +# Bonus library: Unicode, Dammit +# +# This class forces XML data into a standard format (usually to UTF-8 +# or Unicode). It is heavily based on code from Mark Pilgrim's +# Universal Feed Parser. It does not rewrite the XML or HTML to +# reflect a new encoding: that happens in BeautifulStoneSoup.handle_pi +# (XML) and BeautifulSoup.start_meta (HTML). + +# Autodetects character encodings. +# Download from http://chardet.feedparser.org/ +try: + import chardet +# import chardet.constants +# chardet.constants._debug = 1 +except ImportError: + chardet = None + +# cjkcodecs and iconv_codec make Python know about more character encodings. +# Both are available from http://cjkpython.i18n.org/ +# They're built in if you use Python 2.4. +try: + import cjkcodecs.aliases +except ImportError: + pass +try: + import iconv_codec +except ImportError: + pass + +class UnicodeDammit: + """A class for detecting the encoding of a *ML document and + converting it to a Unicode string. If the source encoding is + windows-1252, can replace MS smart quotes with their HTML or XML + equivalents.""" + + # This dictionary maps commonly seen values for "charset" in HTML + # meta tags to the corresponding Python codec names. It only covers + # values that aren't in Python's aliases and can't be determined + # by the heuristics in find_codec. + CHARSET_ALIASES = { "macintosh" : "mac-roman", + "x-sjis" : "shift-jis" } + + def __init__(self, markup, overrideEncodings=[], + smartQuotesTo='xml'): + self.markup, documentEncoding, sniffedEncoding = \ + self._detectEncoding(markup) + self.smartQuotesTo = smartQuotesTo + self.triedEncodings = [] + if markup == '' or isinstance(markup, unicode): + self.originalEncoding = None + self.unicode = unicode(markup) + return + + u = None + for proposedEncoding in overrideEncodings: + u = self._convertFrom(proposedEncoding) + if u: break + if not u: + for proposedEncoding in (documentEncoding, sniffedEncoding): + u = self._convertFrom(proposedEncoding) + if u: break + + # If no luck and we have auto-detection library, try that: + if not u and chardet and not isinstance(self.markup, unicode): + u = self._convertFrom(chardet.detect(self.markup)['encoding']) + + # As a last resort, try utf-8 and windows-1252: + if not u: + for proposed_encoding in ("utf-8", "windows-1252"): + u = self._convertFrom(proposed_encoding) + if u: break + self.unicode = u + if not u: self.originalEncoding = None + + def _subMSChar(self, orig): + """Changes a MS smart quote character to an XML or HTML + entity.""" + sub = self.MS_CHARS.get(orig) + if type(sub) == types.TupleType: + if self.smartQuotesTo == 'xml': + sub = '&#x%s;' % sub[1] + else: + sub = '&%s;' % sub[0] + return sub + + def _convertFrom(self, proposed): + proposed = self.find_codec(proposed) + if not proposed or proposed in self.triedEncodings: + return None + self.triedEncodings.append(proposed) + markup = self.markup + + # Convert smart quotes to HTML if coming from an encoding + # that might have them. + if self.smartQuotesTo and proposed.lower() in("windows-1252", + "iso-8859-1", + "iso-8859-2"): + markup = re.compile("([\x80-\x9f])").sub \ + (lambda(x): self._subMSChar(x.group(1)), + markup) + + try: + # print "Trying to convert document to %s" % proposed + u = self._toUnicode(markup, proposed) + self.markup = u + self.originalEncoding = proposed + except Exception, e: + # print "That didn't work!" + # print e + return None + #print "Correct encoding: %s" % proposed + return self.markup + + def _toUnicode(self, data, encoding): + '''Given a string and its encoding, decodes the string into Unicode. + %encoding is a string recognized by encodings.aliases''' + + # strip Byte Order Mark (if present) + if (len(data) >= 4) and (data[:2] == '\xfe\xff') \ + and (data[2:4] != '\x00\x00'): + encoding = 'utf-16be' + data = data[2:] + elif (len(data) >= 4) and (data[:2] == '\xff\xfe') \ + and (data[2:4] != '\x00\x00'): + encoding = 'utf-16le' + data = data[2:] + elif data[:3] == '\xef\xbb\xbf': + encoding = 'utf-8' + data = data[3:] + elif data[:4] == '\x00\x00\xfe\xff': + encoding = 'utf-32be' + data = data[4:] + elif data[:4] == '\xff\xfe\x00\x00': + encoding = 'utf-32le' + data = data[4:] + newdata = unicode(data, encoding) + return newdata + + def _detectEncoding(self, xml_data): + """Given a document, tries to detect its XML encoding.""" + xml_encoding = sniffed_xml_encoding = None + try: + if xml_data[:4] == '\x4c\x6f\xa7\x94': + # EBCDIC + xml_data = self._ebcdic_to_ascii(xml_data) + elif xml_data[:4] == '\x00\x3c\x00\x3f': + # UTF-16BE + sniffed_xml_encoding = 'utf-16be' + xml_data = unicode(xml_data, 'utf-16be').encode('utf-8') + elif (len(xml_data) >= 4) and (xml_data[:2] == '\xfe\xff') \ + and (xml_data[2:4] != '\x00\x00'): + # UTF-16BE with BOM + sniffed_xml_encoding = 'utf-16be' + xml_data = unicode(xml_data[2:], 'utf-16be').encode('utf-8') + elif xml_data[:4] == '\x3c\x00\x3f\x00': + # UTF-16LE + sniffed_xml_encoding = 'utf-16le' + xml_data = unicode(xml_data, 'utf-16le').encode('utf-8') + elif (len(xml_data) >= 4) and (xml_data[:2] == '\xff\xfe') and \ + (xml_data[2:4] != '\x00\x00'): + # UTF-16LE with BOM + sniffed_xml_encoding = 'utf-16le' + xml_data = unicode(xml_data[2:], 'utf-16le').encode('utf-8') + elif xml_data[:4] == '\x00\x00\x00\x3c': + # UTF-32BE + sniffed_xml_encoding = 'utf-32be' + xml_data = unicode(xml_data, 'utf-32be').encode('utf-8') + elif xml_data[:4] == '\x3c\x00\x00\x00': + # UTF-32LE + sniffed_xml_encoding = 'utf-32le' + xml_data = unicode(xml_data, 'utf-32le').encode('utf-8') + elif xml_data[:4] == '\x00\x00\xfe\xff': + # UTF-32BE with BOM + sniffed_xml_encoding = 'utf-32be' + xml_data = unicode(xml_data[4:], 'utf-32be').encode('utf-8') + elif xml_data[:4] == '\xff\xfe\x00\x00': + # UTF-32LE with BOM + sniffed_xml_encoding = 'utf-32le' + xml_data = unicode(xml_data[4:], 'utf-32le').encode('utf-8') + elif xml_data[:3] == '\xef\xbb\xbf': + # UTF-8 with BOM + sniffed_xml_encoding = 'utf-8' + xml_data = unicode(xml_data[3:], 'utf-8').encode('utf-8') + else: + sniffed_xml_encoding = 'ascii' + pass + xml_encoding_match = re.compile \ + ('^<\?.*encoding=[\'"](.*?)[\'"].*\?>')\ + .match(xml_data) + except: + xml_encoding_match = None + if xml_encoding_match: + xml_encoding = xml_encoding_match.groups()[0].lower() + if sniffed_xml_encoding and \ + (xml_encoding in ('iso-10646-ucs-2', 'ucs-2', 'csunicode', + 'iso-10646-ucs-4', 'ucs-4', 'csucs4', + 'utf-16', 'utf-32', 'utf_16', 'utf_32', + 'utf16', 'u16')): + xml_encoding = sniffed_xml_encoding + return xml_data, xml_encoding, sniffed_xml_encoding + + + def find_codec(self, charset): + return self._codec(self.CHARSET_ALIASES.get(charset, charset)) \ + or (charset and self._codec(charset.replace("-", ""))) \ + or (charset and self._codec(charset.replace("-", "_"))) \ + or charset + + def _codec(self, charset): + if not charset: return charset + codec = None + try: + codecs.lookup(charset) + codec = charset + except (LookupError, ValueError): + pass + return codec + + EBCDIC_TO_ASCII_MAP = None + def _ebcdic_to_ascii(self, s): + c = self.__class__ + if not c.EBCDIC_TO_ASCII_MAP: + emap = (0,1,2,3,156,9,134,127,151,141,142,11,12,13,14,15, + 16,17,18,19,157,133,8,135,24,25,146,143,28,29,30,31, + 128,129,130,131,132,10,23,27,136,137,138,139,140,5,6,7, + 144,145,22,147,148,149,150,4,152,153,154,155,20,21,158,26, + 32,160,161,162,163,164,165,166,167,168,91,46,60,40,43,33, + 38,169,170,171,172,173,174,175,176,177,93,36,42,41,59,94, + 45,47,178,179,180,181,182,183,184,185,124,44,37,95,62,63, + 186,187,188,189,190,191,192,193,194,96,58,35,64,39,61,34, + 195,97,98,99,100,101,102,103,104,105,196,197,198,199,200, + 201,202,106,107,108,109,110,111,112,113,114,203,204,205, + 206,207,208,209,126,115,116,117,118,119,120,121,122,210, + 211,212,213,214,215,216,217,218,219,220,221,222,223,224, + 225,226,227,228,229,230,231,123,65,66,67,68,69,70,71,72, + 73,232,233,234,235,236,237,125,74,75,76,77,78,79,80,81, + 82,238,239,240,241,242,243,92,159,83,84,85,86,87,88,89, + 90,244,245,246,247,248,249,48,49,50,51,52,53,54,55,56,57, + 250,251,252,253,254,255) + import string + c.EBCDIC_TO_ASCII_MAP = string.maketrans( \ + ''.join(map(chr, range(256))), ''.join(map(chr, emap))) + return s.translate(c.EBCDIC_TO_ASCII_MAP) + + MS_CHARS = { '\x80' : ('euro', '20AC'), + '\x81' : ' ', + '\x82' : ('sbquo', '201A'), + '\x83' : ('fnof', '192'), + '\x84' : ('bdquo', '201E'), + '\x85' : ('hellip', '2026'), + '\x86' : ('dagger', '2020'), + '\x87' : ('Dagger', '2021'), + '\x88' : ('circ', '2C6'), + '\x89' : ('permil', '2030'), + '\x8A' : ('Scaron', '160'), + '\x8B' : ('lsaquo', '2039'), + '\x8C' : ('OElig', '152'), + '\x8D' : '?', + '\x8E' : ('#x17D', '17D'), + '\x8F' : '?', + '\x90' : '?', + '\x91' : ('lsquo', '2018'), + '\x92' : ('rsquo', '2019'), + '\x93' : ('ldquo', '201C'), + '\x94' : ('rdquo', '201D'), + '\x95' : ('bull', '2022'), + '\x96' : ('ndash', '2013'), + '\x97' : ('mdash', '2014'), + '\x98' : ('tilde', '2DC'), + '\x99' : ('trade', '2122'), + '\x9a' : ('scaron', '161'), + '\x9b' : ('rsaquo', '203A'), + '\x9c' : ('oelig', '153'), + '\x9d' : '?', + '\x9e' : ('#x17E', '17E'), + '\x9f' : ('Yuml', ''),} + +####################################################################### + + +#By default, act as an HTML pretty-printer. +if __name__ == '__main__': + import sys + soup = BeautifulSoup(sys.stdin.read()) + print soup.prettify() diff --git a/xgoogle/__init__.py b/xgoogle/__init__.py new file mode 100755 index 0000000..49ad2df --- /dev/null +++ b/xgoogle/__init__.py @@ -0,0 +1,34 @@ +#!/usr/bin/python +# +# Peteris Krumins ([email protected]) +# http://www.catonmat.net -- good coders code, great reuse +# +# A Google Python library: +# http://www.catonmat.net/blog/python-library-for-google-search/ +# +# Distributed under MIT license: +# +# Copyright (c) 2009 Peteris Krumins +# +# Permission is hereby granted, free of charge, to any person +# Obtaining a copy of this software and associated documentation +# Files (the "Software"), to deal in the Software without +# Restriction, including without limitation the rights to use, +# Copy, modify, merge, publish, distribute, sublicense, and/or sell +# Copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following +# Conditions: +# +# The above copyright notice and this permission notice shall be +# Included in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +# OTHER DEALINGS IN THE SOFTWARE. +# + diff --git a/xgoogle/browser.py b/xgoogle/browser.py new file mode 100755 index 0000000..c7d2618 --- /dev/null +++ b/xgoogle/browser.py @@ -0,0 +1,105 @@ +#!/usr/bin/python +# +# Peteris Krumins ([email protected]) +# http://www.catonmat.net -- good coders code, great reuse +# +# http://www.catonmat.net/blog/python-library-for-google-search/ +# +# Code is licensed under MIT license. +# + +import random +import socket +import urllib +import urllib2 +import httplib + +BROWSERS = ( + # Top most popular browsers in my access.log on 2009.02.12 + # tail -50000 access.log | + # awk -F\" '{B[$6]++} END { for (b in B) { print B[b] ": " b } }' | + # sort -rn | + # head -20 + 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.6) Gecko/2009011913 Firefox/3.0.6', + 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.0.6) Gecko/2009011912 Firefox/3.0.6', + 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.6) Gecko/2009011913 Firefox/3.0.6 (.NET CLR 3.5.30729)', + 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.0.6) Gecko/2009020911 Ubuntu/8.10 (intrepid) Firefox/3.0.6', + 'Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.0.6) Gecko/2009011913 Firefox/3.0.6', + 'Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.0.6) Gecko/2009011913 Firefox/3.0.6 (.NET CLR 3.5.30729)', + 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.19 (KHTML, like Gecko) Chrome/1.0.154.48 Safari/525.19', + 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.04506.648)', + 'Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.0.6) Gecko/2009020911 Ubuntu/8.10 (intrepid) Firefox/3.0.6', + 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.0.5) Gecko/2008121621 Ubuntu/8.04 (hardy) Firefox/3.0.5', + 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_6; en-us) AppleWebKit/525.27.1 (KHTML, like Gecko) Version/3.2.1 Safari/525.27.1', + 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)', + 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 2.0.50727)', + 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)' +) + +TIMEOUT = 5 # socket timeout + +class BrowserError(Exception): + def __init__(self, url, error): + self.url = url + self.error = error + +class PoolHTTPConnection(httplib.HTTPConnection): + def connect(self): + """Connect to the host and port specified in __init__.""" + msg = "getaddrinfo returns an empty list" + for res in socket.getaddrinfo(self.host, self.port, 0, + socket.SOCK_STREAM): + af, socktype, proto, canonname, sa = res + try: + self.sock = socket.socket(af, socktype, proto) + if self.debuglevel > 0: + print "connect: (%s, %s)" % (self.host, self.port) + self.sock.settimeout(TIMEOUT) + self.sock.connect(sa) + except socket.error, msg: + if self.debuglevel > 0: + print 'connect fail:', (self.host, self.port) + if self.sock: + self.sock.close() + self.sock = None + continue + break + if not self.sock: + raise socket.error, msg + +class PoolHTTPHandler(urllib2.HTTPHandler): + def http_open(self, req): + return self.do_open(PoolHTTPConnection, req) + +class Browser(object): + def __init__(self, user_agent=BROWSERS[0], debug=False, use_pool=False): + self.headers = { + 'User-Agent': user_agent, + 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', + 'Accept-Language': 'en-us,en;q=0.5' + } + self.debug = debug + + def get_page(self, url, data=None): + handlers = [PoolHTTPHandler] + opener = urllib2.build_opener(*handlers) + if data: data = urllib.urlencode(data) + request = urllib2.Request(url, data, self.headers) + try: + response = opener.open(request) + return response.read() + except (urllib2.HTTPError, urllib2.URLError), e: + raise BrowserError(url, str(e)) + except (socket.error, socket.sslerror), msg: + raise BrowserError(url, msg) + except socket.timeout, e: + raise BrowserError(url, "timeout") + except KeyboardInterrupt: + raise + except: + raise BrowserError(url, "unknown error") + + def set_random_user_agent(self): + self.headers['User-Agent'] = random.choice(BROWSERS) + return self.headers['User-Agent'] + diff --git a/xgoogle/googlesets.py b/xgoogle/googlesets.py new file mode 100755 index 0000000..af3d1d0 --- /dev/null +++ b/xgoogle/googlesets.py @@ -0,0 +1,89 @@ +#!/usr/bin/python +# +# Peteris Krumins ([email protected]) +# http://www.catonmat.net -- good coders code, great reuse +# +# http://www.catonmat.net/blog/python-library-for-google-sets/ +# +# Code is licensed under MIT license. +# + +import re +import urllib +import random +from htmlentitydefs import name2codepoint +from BeautifulSoup import BeautifulSoup + +from browser import Browser, BrowserError + +class GSError(Exception): + """ Google Sets Error """ + pass + +class GSParseError(Exception): + """ + Parse error in Google Sets results. + self.msg attribute contains explanation why parsing failed + self.tag attribute contains BeautifulSoup object with the most relevant tag that failed to parse + Thrown only in debug mode + """ + + def __init__(self, msg, tag): + self.msg = msg + self.tag = tag + + def __str__(self): + return self.msg + + def html(self): + return self.tag.prettify() + +LARGE_SET = 1 +SMALL_SET = 2 + +class GoogleSets(object): + URL_LARGE = "http://labs.google.com/sets?hl=en&q1=%s&q2=%s&q3=%s&q4=%s&q5=%s&btn=Large+Set" + URL_SMALL = "http://labs.google.com/sets?hl=en&q1=%s&q2=%s&q3=%s&q4=%s&q5=%s&btn=Small+Set+(15+items+or+fewer)" + + def __init__(self, items, random_agent=False, debug=False): + self.items = items + self.debug = debug + self.browser = Browser(debug=debug) + + if random_agent: + self.browser.set_random_user_agent() + + def get_results(self, set_type=SMALL_SET): + page = self._get_results_page(set_type) + results = self._extract_results(page) + return results + + def _maybe_raise(self, cls, *arg): + if self.debug: + raise cls(*arg) + + def _get_results_page(self, set_type): + if set_type == LARGE_SET: + url = GoogleSets.URL_LARGE + else: + url = GoogleSets.URL_SMALL + + safe_items = [urllib.quote_plus(i) for i in self.items] + blank_items = 5 - len(safe_items) + if blank_items > 0: + safe_items += ['']*blank_items + + safe_url = url % tuple(safe_items) + + try: + page = self.browser.get_page(safe_url) + except BrowserError, e: + raise GSError, "Failed getting %s: %s" % (e.url, e.error) + + return BeautifulSoup(page) + + def _extract_results(self, soup): + a_links = soup.findAll('a', href=re.compile('/search')) + ret_res = [a.string for a in a_links] + return ret_res + diff --git a/xgoogle/search.py b/xgoogle/search.py new file mode 100755 index 0000000..5f1f5f2 --- /dev/null +++ b/xgoogle/search.py @@ -0,0 +1,237 @@ +#!/usr/bin/python +# +# Peteris Krumins ([email protected]) +# http://www.catonmat.net -- good coders code, great reuse +# +# http://www.catonmat.net/blog/python-library-for-google-search/ +# +# Code is licensed under MIT license. +# + +import re +import urllib +from htmlentitydefs import name2codepoint +from BeautifulSoup import BeautifulSoup + +from browser import Browser, BrowserError + +class SearchError(Exception): + """ + Base class for Google Search exceptions. + """ + pass + +class ParseError(SearchError): + """ + Parse error in Google results. + self.msg attribute contains explanation why parsing failed + self.tag attribute contains BeautifulSoup object with the most relevant tag that failed to parse + Thrown only in debug mode + """ + + def __init__(self, msg, tag): + self.msg = msg + self.tag = tag + + def __str__(self): + return self.msg + + def html(self): + return self.tag.prettify() + +class SearchResult: + def __init__(self, title, url, desc): + self.title = title + self.url = url + self.desc = desc + + def __str__(self): + return 'Google Search Result: "%s"' % self.title + +class GoogleSearch(object): + SEARCH_URL_0 = "http://www.google.com/search?hl=en&q=%(query)s&btnG=Google+Search" + NEXT_PAGE_0 = "http://www.google.com/search?hl=en&q=%(query)s&start=%(start)d" + SEARCH_URL_1 = "http://www.google.com/search?hl=en&q=%(query)s&num=%(num)d&btnG=Google+Search" + NEXT_PAGE_1 = "http://www.google.com/search?hl=en&q=%(query)s&num=%(num)d&start=%(start)d" + + def __init__(self, query, random_agent=False, debug=False): + self.query = query + self.debug = debug + self.browser = Browser(debug=debug) + self.results_info = None + self.eor = False # end of results + self._page = 0 + self._results_per_page = 10 + self._last_from = 0 + + if random_agent: + self.browser.set_random_user_agent() + + @property + def num_results(self): + if not self.results_info: + page = self._get_results_page() + self.results_info = self._extract_info(page) + if self.results_info['total'] == 0: + self.eor = True + return self.results_info['total'] + + def _get_page(self): + return self._page + + def _set_page(self, page): + self._page = page + + page = property(_get_page, _set_page) + + def _get_results_per_page(self): + return self._results_per_page + + def _set_results_par_page(self, rpp): + self._results_per_page = rpp + + results_per_page = property(_get_results_per_page, _set_results_par_page) + + def get_results(self): + """ Gets a page of results """ + if self.eor: + return [] + + page = self._get_results_page() + search_info = self._extract_info(page) + if not self.results_info: + self.results_info = search_info + if self.num_results == 0: + self.eor = True + return [] + results = self._extract_results(page) + if not results: + self.eor = True + return [] + if self._page > 0 and search_info['from'] == self._last_from: + self.eor = True + return [] + if search_info['to'] == search_info['total']: + self.eor = True + self._page += 1 + self._last_from = search_info['from'] + return results + + def _maybe_raise(self, cls, *arg): + if self.debug: + raise cls(*arg) + + def _get_results_page(self): + if self._page == 0: + if self._results_per_page == 10: + url = GoogleSearch.SEARCH_URL_0 + else: + url = GoogleSearch.SEARCH_URL_1 + else: + if self._results_per_page == 10: + url = GoogleSearch.NEXT_PAGE_0 + else: + url = GoogleSearch.NEXT_PAGE_1 + + safe_url = url % { 'query': urllib.quote_plus(self.query), + 'start': self._page * self._results_per_page, + 'num': self._results_per_page } + + try: + page = self.browser.get_page(safe_url) + except BrowserError, e: + raise SearchError, "Failed getting %s: %s" % (e.url, e.error) + + return BeautifulSoup(page) + + def _extract_info(self, soup): + empty_info = {'from': 0, 'to': 0, 'total': 0} + div_ssb = soup.find('div', id='ssb') + if not div_ssb: + self._maybe_raise(ParseError, "Div with number of results was not found on Google search page", soup) + return empty_info + p = div_ssb.find('p') + if not p: + self._maybe_raise(ParseError, """<p> tag within <div id="ssb"> was not found on Google search page""", soup) + return empty_info + txt = ''.join(p.findAll(text=True)) + txt = txt.replace(',', '') + matches = re.search(r'Results (\d+) - (\d+) of (?:about )?(\d+)', txt, re.U) + if not matches: + return empty_info + return {'from': int(matches.group(1)), 'to': int(matches.group(2)), 'total': int(matches.group(3))} + + def _extract_results(self, soup): + results = soup.findAll('li', {'class': 'g'}) + ret_res = [] + for result in results: + eres = self._extract_result(result) + if eres: + ret_res.append(eres) + return ret_res + + def _extract_result(self, result): + title, url = self._extract_title_url(result) + desc = self._extract_description(result) + if not title or not url or not desc: + return None + return SearchResult(title, url, desc) + + def _extract_title_url(self, result): + #title_a = result.find('a', {'class': re.compile(r'\bl\b')}) + title_a = result.find('a') + if not title_a: + self._maybe_raise(ParseError, "Title tag in Google search result was not found", result) + return None, None + title = ''.join(title_a.findAll(text=True)) + title = self._html_unescape(title) + url = title_a['href'] + match = re.match(r'/url\?q=(http[^&]+)&', url) + if match: + url = urllib.unquote(match.group(1)) + return title, url + + def _extract_description(self, result): + desc_div = result.find('div', {'class': re.compile(r'\bs\b')}) + if not desc_div: + self._maybe_raise(ParseError, "Description tag in Google search result was not found", result) + return None + + desc_strs = [] + def looper(tag): + if not tag: return + for t in tag: + try: + if t.name == 'br': break + except AttributeError: + pass + + try: + desc_strs.append(t.string) + except AttributeError: + desc_strs.append(t) + + looper(desc_div) + looper(desc_div.find('wbr')) # BeautifulSoup does not self-close <wbr> + + desc = ''.join(s for s in desc_strs if s) + return self._html_unescape(desc) + + def _html_unescape(self, str): + def entity_replacer(m): + entity = m.group(1) + if entity in name2codepoint: + return unichr(name2codepoint[entity]) + else: + return m.group(0) + + def ascii_replacer(m): + cp = int(m.group(1)) + if cp <= 255: + return unichr(cp) + else: + return m.group(0) + + s = re.sub(r'&#(\d+);', ascii_replacer, str, re.U) + return re.sub(r'&([^;]+);', entity_replacer, s, re.U) + diff --git a/xgoogle/sponsoredlinks.py b/xgoogle/sponsoredlinks.py new file mode 100755 index 0000000..12febfe --- /dev/null +++ b/xgoogle/sponsoredlinks.py @@ -0,0 +1,235 @@ +#!/usr/bin/python +# +# Peteris Krumins ([email protected]) +# http://www.catonmat.net -- good coders code, great reuse +# +# http://www.catonmat.net/blog/python-library-for-google-sponsored-links-search/ +# +# Code is licensed under MIT license. +# + +import re +import urllib +import random +from htmlentitydefs import name2codepoint +from BeautifulSoup import BeautifulSoup + +from browser import Browser, BrowserError + +# +# TODO: join GoogleSearch and SponsoredLinks classes under a single base class +# + +class SLError(Exception): + """ Sponsored Links Error """ + pass + +class SLParseError(Exception): + """ + Parse error in Google results. + self.msg attribute contains explanation why parsing failed + self.tag attribute contains BeautifulSoup object with the most relevant tag that failed to parse + Thrown only in debug mode + """ + + def __init__(self, msg, tag): + self.msg = msg + self.tag = tag + + def __str__(self): + return self.msg + + def html(self): + return self.tag.prettify() + +GET_ALL_SLEEP_FUNCTION = object() + +class SponsoredLink(object): + """ a single sponsored link """ + def __init__(self, title, url, display_url, desc): + self.title = title + self.url = url + self.display_url = display_url + self.desc = desc + +class SponsoredLinks(object): + SEARCH_URL_0 = "http://www.google.com/sponsoredlinks?q=%(query)s&btnG=Search+Sponsored+Links&hl=en" + NEXT_PAGE_0 = "http://www.google.com/sponsoredlinks?q=%(query)s&sa=N&start=%(start)d&hl=en" + SEARCH_URL_1 = "http://www.google.com/sponsoredlinks?q=%(query)s&num=%(num)d&btnG=Search+Sponsored+Links&hl=en" + NEXT_PAGE_1 = "http://www.google.com/sponsoredlinks?q=%(query)s&num=%(num)d&sa=N&start=%(start)d&hl=en" + + def __init__(self, query, random_agent=False, debug=False): + self.query = query + self.debug = debug + self.browser = Browser(debug=debug) + self._page = 0 + self.eor = False + self.results_info = None + self._results_per_page = 10 + + if random_agent: + self.browser.set_random_user_agent() + + @property + def num_results(self): + if not self.results_info: + page = self._get_results_page() + self.results_info = self._extract_info(page) + if self.results_info['total'] == 0: + self.eor = True + return self.results_info['total'] + + def _get_results_per_page(self): + return self._results_per_page + + def _set_results_par_page(self, rpp): + self._results_per_page = rpp + + results_per_page = property(_get_results_per_page, _set_results_par_page) + + def get_results(self): + if self.eor: + return [] + page = self._get_results_page() + info = self._extract_info(page) + if self.results_info is None: + self.results_info = info + if info['to'] == info['total']: + self.eor = True + results = self._extract_results(page) + if not results: + self.eor = True + return [] + self._page += 1 + return results + + def _get_all_results_sleep_fn(self): + return random.random()*5 + 1 # sleep from 1 - 6 seconds + + def get_all_results(self, sleep_function=None): + if sleep_function is GET_ALL_SLEEP_FUNCTION: + sleep_function = self._get_all_results_sleep_fn + if sleep_function is None: + sleep_function = lambda: None + ret_results = [] + while True: + res = self.get_results() + if not res: + return ret_results + ret_results.extend(res) + return ret_results + + def _maybe_raise(self, cls, *arg): + if self.debug: + raise cls(*arg) + + def _extract_info(self, soup): + empty_info = { 'from': 0, 'to': 0, 'total': 0 } + stats_span = soup.find('span', id='stats') + if not stats_span: + return empty_info + txt = ''.join(stats_span.findAll(text=True)) + txt = txt.replace(',', '').replace("&nbsp;", ' ') + matches = re.search(r'Results (\d+) - (\d+) of (?:about )?(\d+)', txt) + if not matches: + return empty_info + return {'from': int(matches.group(1)), 'to': int(matches.group(2)), 'total': int(matches.group(3))} + + def _get_results_page(self): + if self._page == 0: + if self._results_per_page == 10: + url = SponsoredLinks.SEARCH_URL_0 + else: + url = SponsoredLinks.SEARCH_URL_1 + else: + if self._results_per_page == 10: + url = SponsoredLinks.NEXT_PAGE_0 + else: + url = SponsoredLinks.NEXT_PAGE_1 + + safe_url = url % { 'query': urllib.quote_plus(self.query), + 'start': self._page * self._results_per_page, + 'num': self._results_per_page } + + try: + page = self.browser.get_page(safe_url) + except BrowserError, e: + raise SLError, "Failed getting %s: %s" % (e.url, e.error) + + return BeautifulSoup(page) + + def _extract_results(self, soup): + results = soup.findAll('div', {'class': 'g'}) + ret_res = [] + for result in results: + eres = self._extract_result(result) + if eres: + ret_res.append(eres) + return ret_res + + def _extract_result(self, result): + title, url = self._extract_title_url(result) + display_url = self._extract_display_url(result) # Warning: removes 'cite' from the result + desc = self._extract_description(result) + if not title or not url or not display_url or not desc: + return None + return SponsoredLink(title, url, display_url, desc) + + def _extract_title_url(self, result): + title_a = result.find('a') + if not title_a: + self._maybe_raise(SLParseError, "Title tag in sponsored link was not found", result) + return None, None + title = ''.join(title_a.findAll(text=True)) + title = self._html_unescape(title) + url = title_a['href'] + match = re.search(r'q=(http[^&]+)&', url) + if not match: + self._maybe_raise(SLParseError, "URL inside a sponsored link was not found", result) + return None, None + url = urllib.unquote(match.group(1)) + return title, url + + def _extract_display_url(self, result): + cite = result.find('cite') + if not cite: + self._maybe_raise(SLParseError, "<cite> not found inside result", result) + return None + + return ''.join(cite.findAll(text=True)) + + def _extract_description(self, result): + cite = result.find('cite') + if not cite: + return None + cite.extract() + + desc_div = result.find('div', {'class': 'line23'}) + if not desc_div: + self._maybe_raise(ParseError, "Description tag not found in sponsored link", result) + return None + + desc_strs = desc_div.findAll(text=True)[0:-1] + desc = ''.join(desc_strs) + desc = desc.replace("\n", " ") + desc = desc.replace(" ", " ") + return self._html_unescape(desc) + + def _html_unescape(self, str): + def entity_replacer(m): + entity = m.group(1) + if entity in name2codepoint: + return unichr(name2codepoint[entity]) + else: + return m.group(0) + + def ascii_replacer(m): + cp = int(m.group(1)) + if cp <= 255: + return unichr(cp) + else: + return m.group(0) + + s = re.sub(r'&#(\d+);', ascii_replacer, str, re.U) + return re.sub(r'&([^;]+);', entity_replacer, s, re.U) + diff --git a/xgoogle/translate.py b/xgoogle/translate.py new file mode 100755 index 0000000..35fc6bb --- /dev/null +++ b/xgoogle/translate.py @@ -0,0 +1,199 @@ +#!/usr/bin/python +# +# Peteris Krumins ([email protected]) +# http://www.catonmat.net -- good coders code, great reuse +# +# http://www.catonmat.net/blog/python-library-for-google-translate/ +# +# Code is licensed under MIT license. +# + +from browser import Browser, BrowserError +from urllib import quote_plus +import simplejson as json + + +class TranslationError(Exception): + pass + +class Translator(object): + translate_url = "http://ajax.googleapis.com/ajax/services/language/translate?v=1.0&q=%(message)s&langpair=%(from)s%%7C%(to)s" + + def __init__(self): + self.browser = Browser() + + def translate(self, message, lang_to='en', lang_from=''): + """ + Given a 'message' translate it from 'lang_from' to 'lang_to'. + If 'lang_from' is empty, auto-detects the language. + Returns the translated message. + """ + + if lang_to not in _languages: + raise TranslationError, "Language %s is not supported as lang_to." % lang_to + if lang_from not in _languages and lang_from != '': + raise TranslationError, "Language %s is not supported as lang_from." % lang_from + + message = quote_plus(message) + real_url = Translator.translate_url % { 'message': message, + 'from': lang_from, + 'to': lang_to } + + try: + translation = self.browser.get_page(real_url) + data = json.loads(translation) + + if data['responseStatus'] != 200: + raise TranslationError, "Failed translating: %s" % data['responseDetails'] + + return data['responseData']['translatedText'] + except BrowserError, e: + raise TranslationError, "Failed translating (getting %s failed): %s" % (e.url, e.error) + except ValueError, e: + raise TranslationError, "Failed translating (json failed): %s" % e.message + except KeyError, e: + raise TranslationError, "Failed translating, response didn't contain the translation" + + return None + +class DetectionError(Exception): + pass + +class Language(object): + def __init__(self, lang, confidence, is_reliable): + self.lang_code = lang + self.lang = _languages[lang] + self.confidence = confidence + self.is_reliable = is_reliable + + def __repr__(self): + return '<Language: %s (%s)>' % (self.lang_code, self.lang) + +class LanguageDetector(object): + detect_url = "http://ajax.googleapis.com/ajax/services/language/detect?v=1.0&q=%(message)s" + + def __init__(self): + self.browser = Browser() + + def detect(self, message): + """ + Given a 'message' detects its language. + Returns Language object. + """ + + message = quote_plus(message) + real_url = LanguageDetector.detect_url % { 'message': message } + + try: + detection = self.browser.get_page(real_url) + data = json.loads(detection) + + if data['responseStatus'] != 200: + raise DetectError, "Failed detecting language: %s" % data['responseDetails'] + + rd = data['responseData'] + return Language(rd['language'], rd['confidence'], rd['isReliable']) + + except BrowserError, e: + raise DetectError, "Failed detecting language (getting %s failed): %s" % (e.url, e.error) + except ValueError, e: + raise DetectErrro, "Failed detecting language (json failed): %s" % e.message + except KeyError, e: + raise DetectError, "Failed detecting language, response didn't contain the necessary data" + + return None + + +_languages = { + 'af': 'Afrikaans', + 'sq': 'Albanian', + 'am': 'Amharic', + 'ar': 'Arabic', + 'hy': 'Armenian', + 'az': 'Azerbaijani', + 'eu': 'Basque', + 'be': 'Belarusian', + 'bn': 'Bengali', + 'bh': 'Bihari', + 'bg': 'Bulgarian', + 'my': 'Burmese', + 'ca': 'Catalan', + 'chr': 'Cherokee', + 'zh': 'Chinese', + 'zh-CN': 'Chinese_simplified', + 'zh-TW': 'Chinese_traditional', + 'hr': 'Croatian', + 'cs': 'Czech', + 'da': 'Danish', + 'dv': 'Dhivehi', + 'nl': 'Dutch', + 'en': 'English', + 'eo': 'Esperanto', + 'et': 'Estonian', + 'tl': 'Filipino', + 'fi': 'Finnish', + 'fr': 'French', + 'gl': 'Galician', + 'ka': 'Georgian', + 'de': 'German', + 'el': 'Greek', + 'gn': 'Guarani', + 'gu': 'Gujarati', + 'iw': 'Hebrew', + 'hi': 'Hindi', + 'hu': 'Hungarian', + 'is': 'Icelandic', + 'id': 'Indonesian', + 'iu': 'Inuktitut', + 'ga': 'Irish', + 'it': 'Italian', + 'ja': 'Japanese', + 'kn': 'Kannada', + 'kk': 'Kazakh', + 'km': 'Khmer', + 'ko': 'Korean', + 'ku': 'Kurdish', + 'ky': 'Kyrgyz', + 'lo': 'Laothian', + 'lv': 'Latvian', + 'lt': 'Lithuanian', + 'mk': 'Macedonian', + 'ms': 'Malay', + 'ml': 'Malayalam', + 'mt': 'Maltese', + 'mr': 'Marathi', + 'mn': 'Mongolian', + 'ne': 'Nepali', + 'no': 'Norwegian', + 'or': 'Oriya', + 'ps': 'Pashto', + 'fa': 'Persian', + 'pl': 'Polish', + 'pt-PT': 'Portuguese', + 'pa': 'Punjabi', + 'ro': 'Romanian', + 'ru': 'Russian', + 'sa': 'Sanskrit', + 'sr': 'Serbian', + 'sd': 'Sindhi', + 'si': 'Sinhalese', + 'sk': 'Slovak', + 'sl': 'Slovenian', + 'es': 'Spanish', + 'sw': 'Swahili', + 'sv': 'Swedish', + 'tg': 'Tajik', + 'ta': 'Tamil', + 'tl': 'Tagalog', + 'te': 'Telugu', + 'th': 'Thai', + 'bo': 'Tibetan', + 'tr': 'Turkish', + 'uk': 'Ukrainian', + 'ur': 'Urdu', + 'uz': 'Uzbek', + 'ug': 'Uighur', + 'vi': 'Vietnamese', + 'cy': 'Welsh', + 'yi': 'Yiddish' +};
bmatthews68/MockNS
63d0c6d498b9f3825ce7725330114c046aa53db5
Added spy support
diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java index 1e55bd0..ce98848 100644 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java @@ -1,82 +1,82 @@ -/* - * Copyright 2009-2011 Brian Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito; - -import org.springframework.beans.factory.support.BeanDefinitionBuilder; -import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; -import org.w3c.dom.Element; - -/** - * The bean definition parser for the Mockito mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public final class MockBeanDefinitionParser - extends AbstractSingleBeanDefinitionParser -{ - /** - * The default constructor. - */ - public MockBeanDefinitionParser() - { - } - - /** - * Parse an XML bean definition. - * - * @param element - * The element that defines the bean. - * @param builder - * Helps build the bean definition. - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) - */ - @Override - protected void doParse(final Element element, final BeanDefinitionBuilder builder) - { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - } - - /** - * Get class of the factory used to create the beans. - * - * @param element - * The element that defines the bean. - * @return Always returns {@link MockFactoryBean}. - * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) - */ - @SuppressWarnings("rawtypes") - @Override - protected Class getBeanClass(final Element element) - { - return MockFactoryBean.class; - } - - /** - * Indicate that the bean factory should generate an identifier for the bean - * if one is not present. - * - * @return Always returns <code>true</code> - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() - */ - @Override - protected boolean shouldGenerateIdAsFallback() - { - return true; - } -} +/* + * Copyright 2009-2011 Brian Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the Mockito mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 1.0.0 + */ +public final class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } + + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } + + /** + * Get class of the factory used to create the beans. + * + * @param element + * The element that defines the bean. + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("rawtypes") + @Override + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } + + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } +} diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java index d9752cc..21cb806 100644 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java @@ -1,79 +1,79 @@ -/* - * Copyright 2009-2011 Brian Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito; - -import org.mockito.Mockito; -import org.springframework.beans.factory.FactoryBean; - -/** - * The bean definition parser for the EasyMock mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public final class MockFactoryBean<T> - implements FactoryBean<T> -{ - /** - * The interface or class to be mocked. - */ - private Class<T> objectClass; - - /** - * The constructor. - * - * @param clazz - * The interface or class to be mocked. - */ - public MockFactoryBean(final Class<T> clazz) - { - this.objectClass = clazz; - } - - /** - * Create the mock object. - * - * @return The mock object. - * @see org.springframework.beans.factory.FactoryBean#getObject() - */ - public T getObject() - { - return Mockito.mock(this.objectClass); - } - - /** - * Return the interface or class that will be mocked. - * - * @return The interface or class. - * @see org.springframework.beans.factory.FactoryBean#getObjectType() - */ - public Class<T> getObjectType() - { - return this.objectClass; - } - - /** - * Indicate that mock objects created by this factory are singletons. - * - * @return Always returns <code>true</code>. - * @see org.springframework.beans.factory.FactoryBean#isSingleton() - */ - public boolean isSingleton() - { - return true; - } -} +/* + * Copyright 2009-2011 Brian Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.mockito.Mockito; +import org.springframework.beans.factory.FactoryBean; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 1.0.0 + */ +public final class MockFactoryBean<T> + implements FactoryBean<T> +{ + /** + * The interface or class to be mocked. + */ + private Class<T> objectClass; + + /** + * The constructor. + * + * @param clazz + * The interface or class to be mocked. + */ + public MockFactoryBean(final Class<T> clazz) + { + this.objectClass = clazz; + } + + /** + * Create the mock object. + * + * @return The mock object. + * @see org.springframework.beans.factory.FactoryBean#getObject() + */ + public T getObject() + { + return Mockito.mock(this.objectClass); + } + + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + * @see org.springframework.beans.factory.FactoryBean#getObjectType() + */ + public Class<T> getObjectType() + { + return this.objectClass; + } + + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + * @see org.springframework.beans.factory.FactoryBean#isSingleton() + */ + public boolean isSingleton() + { + return true; + } +} diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java index adbc0bc..7720483 100644 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java @@ -1,47 +1,48 @@ -/* - * Copyright 2009-2011 Brian Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito; - -import org.springframework.beans.factory.xml.NamespaceHandlerSupport; - -/** - * The name-space hander for the Mockito. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public final class NamespaceHandler - extends NamespaceHandlerSupport -{ - /** - * The default constructor. - */ - public NamespaceHandler() - { - } - - /** - * Register the bean definition parsers for the name-space. - * - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - public void init() - { - this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); - } - -} +/* + * Copyright 2009-2011 Brian Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the Mockito. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 1.0.0 + */ +public final class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } + + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + this.registerBeanDefinitionParser("spy", new SpyBeanDefinitionParser()); + } + +} diff --git a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd index 1742595..3b16ae5 100644 --- a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd +++ b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd @@ -1,45 +1,64 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Copyright (c) 2009 Brian Thomas Matthews - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<xsd:schema - xmlns="http://mockns.btmatthews.com/schema/mockito" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns:beans="http://www.springframework.org/schema/beans" - targetNamespace="http://mockns.btmatthews.com/schema/mockito" - elementFormDefault="qualified" - attributeFormDefault="unqualified"> - <xsd:import - namespace="http://www.springframework.org/schema/beans" /> - <xsd:element - name="mock"> - <xsd:annotation> - <xsd:documentation><![CDATA[ - Create an Mockito mock bean. - ]]></xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:complexContent> - <xsd:extension - base="beans:identifiedType"> - <xsd:attribute - name="object-class" - type="xsd:string" - use="required" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - </xsd:element> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/mockito" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/mockito" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an Mockito mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> + <xsd:element + name="spy"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an Mockito spy bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> </xsd:schema> \ No newline at end of file diff --git a/pom.xml b/pom.xml index 15dfe51..ebcec24 100644 --- a/pom.xml +++ b/pom.xml @@ -1,236 +1,236 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Copyright (c) 2009-2011 Brian Thomas Matthews - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://maven.apache.org/POM/4.0.0 - http://maven.apache.org/maven-v4_0_0.xsd"> - <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns</artifactId> - <packaging>pom</packaging> - <name>MockNS</name> - <version>1.0.0-SNAPSHOT</version> - <modules> - <module>mockns-easymock</module> - <module>mockns-jmock</module> - <module>mockns-mockito</module> - </modules> - <description></description> - <url>http://mockns.btmatthews.com</url> - <inceptionYear>2009</inceptionYear> - <licenses> - <license> - <name>Apache 2</name> - <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> - <distribution>repo</distribution> - </license> - </licenses> - <reporting> - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>findbugs-maven-plugin</artifactId> - <version>2.3.2</version> - </plugin> - <plugin> - <artifactId>maven-checkstyle-plugin</artifactId> - <version>2.6</version> - <configuration> - <configLocation>../checkstyle.xml</configLocation> - <encoding>UTF-8</encoding> - </configuration> - </plugin> - <plugin> - <artifactId>maven-pmd-plugin</artifactId> - <version>2.5</version> - <configuration> - <aggregate>true</aggregate> - <linkXRef>true</linkXRef> - <sourceEncoding>UTF-8</sourceEncoding> - <targetJdk>1.5</targetJdk> - </configuration> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>taglist-maven-plugin</artifactId> - <version>2.4</version> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>jdepend-maven-plugin</artifactId> - <version>2.0-beta-2</version> - </plugin> - <plugin> - <artifactId>maven-surefire-report-plugin</artifactId> - <version>2.9</version> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>cobertura-maven-plugin</artifactId> - <version>2.5.1</version> - <configuration> - <quiet>true</quiet> - </configuration> - </plugin> - <plugin> - <artifactId>maven-jxr-plugin</artifactId> - <version>2.3</version> - <configuration> - <aggregate>true</aggregate> - <outputEncoding>UTF-8</outputEncoding> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>2.8</version> - <configuration> - <executions> - <execution> - <goals> - <goal>aggregate</goal> - <goal>test-aggregate</goal> - </goals> - <configuration> - <encoding>UTF-8</encoding> - </configuration> - </execution> - </executions> - </configuration> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>dashboard-maven-plugin</artifactId> - <version>1.0.0-beta-1</version> - </plugin> - </plugins> - </reporting> - <organization> - <name>Brian Matthews</name> - <url>http://btmatthews.com</url> - </organization> - <developers> - <developer> - <id>bmatthews68</id> - <name>Brian Matthews</name> - <email>[email protected]</email> - <url>http://brian.btmatthews.com</url> - <organization>btmatthews.com</organization> - <organizationUrl>http://btmatthews.com</organizationUrl> - <roles> - <role>developer</role> - </roles> - <timezone>0</timezone> - </developer> - </developers> - <build> - <pluginManagement> - <plugins> - <plugin> - <artifactId>maven-plugin-plugin</artifactId> - <version>2.8</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-site-plugin</artifactId> - <version>3.0</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <version>2.3.2</version> - <configuration> - <source>1.5</source> - <target>1.5</target> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-surefire-plugin</artifactId> - <version>2.9</version> - </plugin> - </plugins> - </pluginManagement> - </build> - <dependencyManagement> - <dependencies> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-beans</artifactId> - <version>3.0.5.RELEASE</version> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-context</artifactId> - <version>3.0.5.RELEASE</version> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-test</artifactId> - <version>3.0.5.RELEASE</version> - </dependency> - <dependency> - <groupId>org.easymock</groupId> - <artifactId>easymock</artifactId> - <version>3.0</version> - </dependency> - <dependency> - <groupId>org.easymock</groupId> - <artifactId>easymockclassextension</artifactId> - <version>3.0</version> - </dependency> - <dependency> - <groupId>org.jmock</groupId> - <artifactId>jmock</artifactId> - <version>2.5.1</version> - </dependency> - <dependency> - <groupId>org.mockito</groupId> - <artifactId>mockito-core</artifactId> - <version>1.8.5</version> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <version>4.8.2</version> - </dependency> - </dependencies> - </dependencyManagement> - <issueManagement> - <url>https://github.com/bmatthews68/ldap-maven-plugin/issues</url> - <system>GitHub</system> - </issueManagement> - <distributionManagement> - <site> - <id>gh-pages</id> - <url>gitsite:[email protected]/bmatthews68/ldap-maven-plugin.git</url> - </site> - <repository> - <id>releases.sonatype</id> - <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url> - </repository> - <snapshotRepository> - <id>snapshots.sonatype</id> - <url>https://oss.sonatype.org/content/repositories/snapshots</url> - </snapshotRepository> - </distributionManagement> - <scm> - <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> - <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> - <url>http://github.com/bmatthews68/MockNS</url> - </scm> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009-2011 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <packaging>pom</packaging> + <name>MockNS</name> + <version>1.0.0-SNAPSHOT</version> + <modules> + <module>mockns-easymock</module> + <module>mockns-jmock</module> + <module>mockns-mockito</module> + </modules> + <description></description> + <url>http://mockns.btmatthews.com</url> + <inceptionYear>2009</inceptionYear> + <licenses> + <license> + <name>Apache 2</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + </license> + </licenses> + <reporting> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <version>2.3.2</version> + </plugin> + <plugin> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.6</version> + <configuration> + <configLocation>../checkstyle.xml</configLocation> + <encoding>UTF-8</encoding> + </configuration> + </plugin> + <plugin> + <artifactId>maven-pmd-plugin</artifactId> + <version>2.5</version> + <configuration> + <aggregate>true</aggregate> + <linkXRef>true</linkXRef> + <sourceEncoding>UTF-8</sourceEncoding> + <targetJdk>1.5</targetJdk> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>taglist-maven-plugin</artifactId> + <version>2.4</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>jdepend-maven-plugin</artifactId> + <version>2.0-beta-2</version> + </plugin> + <plugin> + <artifactId>maven-surefire-report-plugin</artifactId> + <version>2.9</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>cobertura-maven-plugin</artifactId> + <version>2.5.1</version> + <configuration> + <quiet>true</quiet> + </configuration> + </plugin> + <plugin> + <artifactId>maven-jxr-plugin</artifactId> + <version>2.3</version> + <configuration> + <aggregate>true</aggregate> + <outputEncoding>UTF-8</outputEncoding> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.8</version> + <configuration> + <executions> + <execution> + <goals> + <goal>aggregate</goal> + <goal>test-aggregate</goal> + </goals> + <configuration> + <encoding>UTF-8</encoding> + </configuration> + </execution> + </executions> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>dashboard-maven-plugin</artifactId> + <version>1.0.0-beta-1</version> + </plugin> + </plugins> + </reporting> + <organization> + <name>Brian Matthews</name> + <url>http://btmatthews.com</url> + </organization> + <developers> + <developer> + <id>bmatthews68</id> + <name>Brian Matthews</name> + <email>[email protected]</email> + <url>http://brian.btmatthews.com</url> + <organization>btmatthews.com</organization> + <organizationUrl>http://btmatthews.com</organizationUrl> + <roles> + <role>developer</role> + </roles> + <timezone>0</timezone> + </developer> + </developers> + <build> + <pluginManagement> + <plugins> + <plugin> + <artifactId>maven-plugin-plugin</artifactId> + <version>2.8</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.0</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <version>2.3.2</version> + <configuration> + <source>1.5</source> + <target>1.5</target> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <version>2.9</version> + </plugin> + </plugins> + </pluginManagement> + </build> + <dependencyManagement> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + <version>3.0.6.RELEASE</version> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + <version>3.0.6.RELEASE</version> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <version>3.0.6.RELEASE</version> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymock</artifactId> + <version>3.0</version> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymockclassextension</artifactId> + <version>3.0</version> + </dependency> + <dependency> + <groupId>org.jmock</groupId> + <artifactId>jmock</artifactId> + <version>2.5.1</version> + </dependency> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + <version>1.8.5</version> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <version>4.8.2</version> + </dependency> + </dependencies> + </dependencyManagement> + <issueManagement> + <url>https://github.com/bmatthews68/ldap-maven-plugin/issues</url> + <system>GitHub</system> + </issueManagement> + <distributionManagement> + <site> + <id>gh-pages</id> + <url>gitsite:[email protected]/bmatthews68/ldap-maven-plugin.git</url> + </site> + <repository> + <id>releases.sonatype</id> + <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url> + </repository> + <snapshotRepository> + <id>snapshots.sonatype</id> + <url>https://oss.sonatype.org/content/repositories/snapshots</url> + </snapshotRepository> + </distributionManagement> + <scm> + <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> + <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> + <url>http://github.com/bmatthews68/MockNS</url> + </scm> </project> \ No newline at end of file
bmatthews68/MockNS
e8bce11b9de6f1ac8b726b8859940dc46d99b2a7
Updating project copyright notices, POM configuration and dependencies
diff --git a/.classpath b/.classpath index 25df935..cc6c05c 100644 --- a/.classpath +++ b/.classpath @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> <classpath> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5"/> <classpathentry kind="output" path="target/classes"/> </classpath> diff --git a/.project b/.project index 9b7d29a..82ec9cc 100644 --- a/.project +++ b/.project @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="UTF-8"?> <projectDescription> <name>mockns</name> <comment></comment> <projects> </projects> <buildSpec> <buildCommand> <name>org.eclipse.wst.common.project.facet.core.builder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.eclipse.jdt.core.javabuilder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.maven.ide.eclipse.maven2Builder</name> <arguments> </arguments> </buildCommand> + <buildCommand> + <name>org.eclipse.m2e.core.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> </buildSpec> <natures> + <nature>org.eclipse.m2e.core.maven2Nature</nature> <nature>org.eclipse.jdt.core.javanature</nature> <nature>org.maven.ide.eclipse.maven2Nature</nature> <nature>org.eclipse.wst.common.project.facet.core.nature</nature> </natures> </projectDescription> diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs index 77f127f..8d9bdf5 100644 --- a/.settings/org.eclipse.jdt.core.prefs +++ b/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,8 @@ -#Tue Sep 15 21:35:42 BST 2009 +#Mon Aug 15 22:28:50 BST 2011 eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5 +org.eclipse.jdt.core.compiler.compliance=1.5 +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.source=1.5 diff --git a/mockns-easymock/.classpath b/mockns-easymock/.classpath index 7c3d14f..3c96d64 100644 --- a/mockns-easymock/.classpath +++ b/mockns-easymock/.classpath @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" output="target/classes" path="src/main/java"/> <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5"/> + <classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"/> <classpathentry kind="output" path="target/classes"/> </classpath> diff --git a/mockns-easymock/.project b/mockns-easymock/.project index 077ba71..99090b6 100644 --- a/mockns-easymock/.project +++ b/mockns-easymock/.project @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="UTF-8"?> <projectDescription> <name>mockns-easymock</name> <comment></comment> <projects> </projects> <buildSpec> <buildCommand> <name>org.eclipse.wst.common.project.facet.core.builder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.eclipse.jdt.core.javabuilder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.maven.ide.eclipse.maven2Builder</name> <arguments> </arguments> </buildCommand> + <buildCommand> + <name>org.eclipse.m2e.core.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> </buildSpec> <natures> + <nature>org.eclipse.m2e.core.maven2Nature</nature> <nature>org.eclipse.jdt.core.javanature</nature> <nature>org.maven.ide.eclipse.maven2Nature</nature> <nature>org.eclipse.wst.common.project.facet.core.nature</nature> </natures> </projectDescription> diff --git a/mockns-easymock/.settings/org.eclipse.jdt.core.prefs b/mockns-easymock/.settings/org.eclipse.jdt.core.prefs index 097f855..f14e8d3 100644 --- a/mockns-easymock/.settings/org.eclipse.jdt.core.prefs +++ b/mockns-easymock/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,6 @@ -#Tue Sep 15 21:35:47 BST 2009 +#Sun Aug 14 03:24:03 BST 2011 eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5 +org.eclipse.jdt.core.compiler.compliance=1.5 +org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning +org.eclipse.jdt.core.compiler.source=1.5 diff --git a/mockns-easymock/pom.xml b/mockns-easymock/pom.xml index ac7bf51..aaa9cbf 100644 --- a/mockns-easymock/pom.xml +++ b/mockns-easymock/pom.xml @@ -1,58 +1,57 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright 2009-2011 Brian Thomas Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> - <version>0.1.0-SNAPSHOT</version> + <version>1.0.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-easymock</artifactId> <name>MockNS for EasyMock</name> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project> \ No newline at end of file diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java index 490656a..f027285 100644 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java @@ -1,82 +1,78 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** * The bean definition parser for the EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ -public final class MockBeanDefinitionParser - extends AbstractSingleBeanDefinitionParser -{ - /** - * The default constructor. - */ - public MockBeanDefinitionParser() - { - } +public final class MockBeanDefinitionParser extends + AbstractSingleBeanDefinitionParser { + /** + * The default constructor. + */ + public MockBeanDefinitionParser() { + } - /** - * Parse an XML bean definition. - * - * @param element - * The element that defines the bean. - * @param builder - * Helps build the bean definition. - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) - */ - @Override - protected void doParse(final Element element, final BeanDefinitionBuilder builder) - { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - } + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, + final BeanDefinitionBuilder builder) { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } - /** - * Get class of the factory used to create the beans. - * - * @param element - * The element that defines the bean. - * @return Always returns {@link MockFactoryBean}. - * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) - */ - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) - { - return MockFactoryBean.class; - } + /** + * Get class of the factory used to create the beans. + * + * @param element + * The element that defines the bean. + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("rawtypes") + @Override + protected Class getBeanClass(final Element element) { + return MockFactoryBean.class; + } - /** - * Indicate that the bean factory should generate an identifier for the bean - * if one is not present. - * - * @return Always returns <code>true</code> - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() - */ - @Override - protected boolean shouldGenerateIdAsFallback() - { - return true; - } + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() { + return true; + } } diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java index bda8862..20198b6 100644 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java @@ -1,83 +1,70 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock; -import org.easymock.classextension.EasyMock; +import org.easymock.EasyMock; import org.springframework.beans.factory.FactoryBean; /** * The factory bean that creates EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ -public final class MockFactoryBean - implements FactoryBean -{ - /** - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - private Class objectClass; +public final class MockFactoryBean<T> implements FactoryBean<T> { + /** + * The interface or class to be mocked. + */ + private Class<T> objectClass; - /** - * The constructor. - * - * @param clazz - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class clazz) - { - this.objectClass = clazz; - } + /** + * The constructor. + * + * @param clazz + * The interface or class to be mocked. + */ + public MockFactoryBean(final Class<T> clazz) { + this.objectClass = clazz; + } - /** - * Create the mock object. - * - * @return The mock object. - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() - { - return EasyMock.createMock(this.objectClass); - } + /** + * Create the mock object. + * + * @return The mock object. + */ + public T getObject() { + return EasyMock.createMock(this.objectClass); + } - /** - * Return the interface or class that will be mocked. - * - * @return The interface or class. - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() - { - return this.objectClass; - } + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + */ + public Class<?> getObjectType() { + return this.objectClass; + } - /** - * Indicate that mock objects created by this factory are singletons. - * - * @return Always returns <code>true</code>. - */ - @Override - public boolean isSingleton() - { - return true; - } + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + */ + public boolean isSingleton() { + return true; + } } diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java index 2c9bb50..1dba203 100644 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java @@ -1,47 +1,43 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** * The name-space hander for the EasyMock. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ -public final class NamespaceHandler - extends NamespaceHandlerSupport -{ - /** - * The default constructor. - */ - public NamespaceHandler() - { - } +public final class NamespaceHandler extends NamespaceHandlerSupport { + /** + * The default constructor. + */ + public NamespaceHandler() { + } - /** - * Register the bean definition parsers for the name-space. - * - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() - { - this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); - } + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + public void init() { + this.registerBeanDefinitionParser("mock", + new MockBeanDefinitionParser()); + } } diff --git a/mockns-easymock/src/main/resources/META-INF/spring.handlers b/mockns-easymock/src/main/resources/META-INF/spring.handlers index b8b59c4..b0e96af 100644 --- a/mockns-easymock/src/main/resources/META-INF/spring.handlers +++ b/mockns-easymock/src/main/resources/META-INF/spring.handlers @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews +# Copyright 2009-2011 Brian Thomas Matthews # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. http\://mockns.btmatthews.com/schema/easymock=com.btmatthews.mockns.easymock.NamespaceHandler \ No newline at end of file diff --git a/mockns-easymock/src/main/resources/META-INF/spring.schemas b/mockns-easymock/src/main/resources/META-INF/spring.schemas index 503b980..491421f 100644 --- a/mockns-easymock/src/main/resources/META-INF/spring.schemas +++ b/mockns-easymock/src/main/resources/META-INF/spring.schemas @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews +# Copyright 2009-2011 Brian Thomas Matthews # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. http\://mockns.btmatthews.com/schema/easymock/easymock.xsd=com/btmatthews/mockns/easymock/easymock.xsd \ No newline at end of file diff --git a/mockns-easymock/src/site/apt/usage.apt b/mockns-easymock/src/site/apt/usage.apt index ecb0018..c66f390 100644 --- a/mockns-easymock/src/site/apt/usage.apt +++ b/mockns-easymock/src/site/apt/usage.apt @@ -1,65 +1,65 @@ ------ Usage ------ Brian Matthews ------ 2009-09-25 ------ -~~ Copyright (c) 2009 Brian Thomas Matthews +~~ Copyright 2009-2011 Brian Matthews ~~ ~~ Licensed under the Apache License, Version 2.0 (the "License"); ~~ you may not use this file except in compliance with the License. ~~ You may obtain a copy of the License at ~~ ~~ http://www.apache.org/licenses/LICENSE-2.0 ~~ ~~ Unless required by applicable law or agreed to in writing, software ~~ distributed under the License is distributed on an "AS IS" BASIS, ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ~~ See the License for the specific language governing permissions and ~~ limitations under the License. Usage The following steps describe the usage of the Spring name-space support for Easy Mock. * Step 1 - Dependency Add the following dependency to your POM. ------------------- <dependency> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-easymock</artifactId> <version>${pom.version}</version> </dependency> ------------------- * Step 2 - Include Namespace in your XML ------------------- <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mockns="http://mockns.btmatthews.com/schema/easymock" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://mockns.btmatthews.com/schema/easymock http://mockns.btmatthews.com/schema/easymock/easymock.xsd"> . . . </beans> ------------------- * Step 3 - Declare your mock object bean ------------------- <mockns:mock id="dependency" object-class="com.btmatthews.mockns.easymock.test.Dependency" /> ------------------- diff --git a/mockns-easymock/src/site/site.xml b/mockns-easymock/src/site/site.xml index 602d75f..048396f 100644 --- a/mockns-easymock/src/site/site.xml +++ b/mockns-easymock/src/site/site.xml @@ -1,43 +1,43 @@ <?xml version="1.0" encoding="ISO-8859-1" ?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright 2009-2011 Brian Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <project name="${project.name}"> <bannerLeft> <name>MockNS</name> <href>http://mockns.btmatthews.com</href> </bannerLeft> <publishDate format="dd MMM yyyy" position="left" /> <version position="left" /> <body> <links> <item name="Spring" href="http://www.springframework.org/" /> <item name="EasyMock" href="http://easymock.org/" /> <item name="jMock" href="http://www.jmock.org/" /> <item name="Mockito" href="http://mockito.org/" /> <item name="Maven 2" href="http://maven.apache.org/" /> <item name="GitHub" href="http://github.com/" /> </links> <menu name="Overview"> <item name="Introduction" href="index.html" /> <item name="Usage" href="usage.html" /> </menu> <menu ref="parent" /> <menu ref="reports" /> </body> <poweredBy> <logo name="Maven" href="http://maven.apache.org/" img="http://maven.apache.org/images/logos/maven-feather.png"/> </poweredBy> </project> \ No newline at end of file diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java index 81df73c..0dc94ba 100644 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java @@ -1,31 +1,31 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock.test; /** * Interface to be mocked during testing. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public interface Dependency { /** * Operation to be mocked during testing. */ void doSomething(); } diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java index ae828ed..abfce34 100644 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java @@ -1,49 +1,49 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock.test; import org.springframework.beans.factory.annotation.Autowired; /** * Simple service used to test mocks. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class Service { /** * The mock object is injected. */ @Autowired private Dependency testDependency; /** * The default constructor. */ public Service() { } /** * Operation to test the mock object invocation. */ public void doSomething() { this.testDependency.doSomething(); } } diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java index 96215cc..efd8ffc 100644 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java @@ -1,67 +1,67 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock.test; -import org.easymock.classextension.EasyMock; +import org.easymock.EasyMock; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * Unit test the Easy Mock implementation for MockNS. * * @author <a href="mailto:[email protected]">[email protected]</a> * @version 0.1.0 */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration public final class TestMockNamespace { /** * Used to test the mocked object. */ @Autowired private Service service; /** * The mocked object. */ @Autowired private Dependency dependency; /** * The default constructor. */ public TestMockNamespace() { } /** * Test the mocked object. */ @Test public void test() { this.dependency.doSomething(); EasyMock.expectLastCall(); EasyMock.replay(this.dependency); this.service.doSomething(); EasyMock.verify(this.dependency); } } diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java index 501f7b8..497c34d 100644 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java @@ -1,67 +1,67 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock.test; -import org.easymock.classextension.EasyMock; +import org.easymock.EasyMock; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * Unit test the Easy Mock implementation for MockNS. * * @author <a href="mailto:[email protected]">[email protected]</a> * @version 0.1.0 */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration public final class TestMockNamespaceWithAnonymousBean { /** * Used to test the mocked object. */ @Autowired private Service service; /** * The mocked object. */ @Autowired private Dependency dependency; /** * The default constructor. */ public TestMockNamespaceWithAnonymousBean() { } /** * Test the mocked object. */ @Test public void test() { this.dependency.doSomething(); EasyMock.expectLastCall(); EasyMock.replay(this.dependency); this.service.doSomething(); EasyMock.verify(this.dependency); } } diff --git a/mockns-jmock/.classpath b/mockns-jmock/.classpath index 7c3d14f..7a7b94d 100644 --- a/mockns-jmock/.classpath +++ b/mockns-jmock/.classpath @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" output="target/classes" path="src/main/java"/> <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> - <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5"/> + <classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"/> <classpathentry kind="output" path="target/classes"/> </classpath> diff --git a/mockns-jmock/.project b/mockns-jmock/.project index d3deb76..dba5868 100644 --- a/mockns-jmock/.project +++ b/mockns-jmock/.project @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="UTF-8"?> <projectDescription> <name>mockns-jmock</name> <comment></comment> <projects> </projects> <buildSpec> <buildCommand> <name>org.eclipse.wst.common.project.facet.core.builder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.eclipse.jdt.core.javabuilder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.maven.ide.eclipse.maven2Builder</name> <arguments> </arguments> </buildCommand> + <buildCommand> + <name>org.eclipse.m2e.core.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> </buildSpec> <natures> + <nature>org.eclipse.m2e.core.maven2Nature</nature> <nature>org.eclipse.jdt.core.javanature</nature> <nature>org.maven.ide.eclipse.maven2Nature</nature> <nature>org.eclipse.wst.common.project.facet.core.nature</nature> </natures> </projectDescription> diff --git a/mockns-jmock/.settings/org.eclipse.jdt.core.prefs b/mockns-jmock/.settings/org.eclipse.jdt.core.prefs index 1eadcad..f14e8d3 100644 --- a/mockns-jmock/.settings/org.eclipse.jdt.core.prefs +++ b/mockns-jmock/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,6 @@ -#Tue Sep 15 21:35:49 BST 2009 +#Sun Aug 14 03:24:03 BST 2011 eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5 +org.eclipse.jdt.core.compiler.compliance=1.5 +org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning +org.eclipse.jdt.core.compiler.source=1.5 diff --git a/mockns-jmock/pom.xml b/mockns-jmock/pom.xml index a484808..dd828a4 100644 --- a/mockns-jmock/pom.xml +++ b/mockns-jmock/pom.xml @@ -1,54 +1,53 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright 2009-2011 Brian Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> - <version>0.1.0-SNAPSHOT</version> + <version>1.0.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-jmock</artifactId> <name>MockNS for jMock</name> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> </dependency> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project> \ No newline at end of file diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java index 63a53d7..4fd4037 100644 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java @@ -1,92 +1,92 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** * The bean definition parser for the jMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class MockBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { /** * The default constructor. */ public MockBeanDefinitionParser() { } /** * Parse an XML bean definition. * * @param element * The element that defines the bean. * @param builder * Helps build the bean definition. * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) */ @Override protected void doParse(final Element element, final BeanDefinitionBuilder builder) { final String objectClass = element.getAttribute("object-class"); builder.addConstructorArgValue(objectClass); final String mockery = element.getAttribute("mockery"); if (mockery != null) { builder.addConstructorArgReference(mockery); } else { builder.addConstructorArgReference("mockery"); } } /** * Get class of the factory used to create the beans. * * @param element * The element that defines the bean. * @return Always returns {@link MockFactoryBean}. * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) */ - @SuppressWarnings("unchecked") + @SuppressWarnings("rawtypes") @Override protected Class getBeanClass(final Element element) { return MockFactoryBean.class; } /** * Indicate that the bean factory should generate an identifier for the bean * if one is not present. * * @return Always returns <code>true</code> * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() */ @Override protected boolean shouldGenerateIdAsFallback() { return true; } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java index 036fbc5..12918e4 100644 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java @@ -1,94 +1,87 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.jmock.Mockery; import org.springframework.beans.factory.FactoryBean; /** * The bean definition parser for the EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ -public final class MockFactoryBean - implements FactoryBean +public final class MockFactoryBean<T> + implements FactoryBean<T> { /** * The interface or class to be mocked. */ - @SuppressWarnings("unchecked") - private Class objectClass; + private Class<T> objectClass; /** * The context for the mocked objects. */ private Mockery mockery; /** * The constructor. * * @param clazz * The interface or class to be mocked. * @param context * The context for the mocked objects. */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class clazz, final Mockery context) + public MockFactoryBean(final Class<T> clazz, final Mockery context) { this.objectClass = clazz; this.mockery = context; } /** * Create the mock object. * * @return The mock object. * @see org.springframework.beans.factory.FactoryBean#getObject() */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() + public T getObject() { return this.mockery.mock(this.objectClass); } /** * Return the interface or class that will be mocked. * * @return The interface or class. * @see org.springframework.beans.factory.FactoryBean#getObjectType() */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() + public Class<T> getObjectType() { return this.objectClass; } /** * Indicate that mock objects created by this factory are singletons. * * @return Always returns <code>true</code>. * @see org.springframework.beans.factory.FactoryBean#isSingleton() */ - @Override public boolean isSingleton() { return true; } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java index cb9bbe3..52b7bbf 100644 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java @@ -1,53 +1,53 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.jmock.Mockery; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** * The bean definition parser for the jMock mockery context objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class MockeryBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { /** * The default constructor. */ public MockeryBeanDefinitionParser() { } /** * Get class of the factory used to create the beans. * * @param element * The element that defines the bean. * @return Always returns {@link MockFactoryBean}. * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) */ - @SuppressWarnings("unchecked") + @SuppressWarnings("rawtypes") @Override protected Class getBeanClass(final Element element) { return Mockery.class; } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java index 7f67949..932f899 100644 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java @@ -1,49 +1,48 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** * The name-space hander for the jMock. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class NamespaceHandler extends NamespaceHandlerSupport { /** * The default constructor. */ public NamespaceHandler() { } /** * Register the bean definition parsers for the name-space. * * @see org.springframework.beans.factory.xml.NamespaceHandler#init() */ - @Override public void init() { this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); this.registerBeanDefinitionParser("mockery", new MockeryBeanDefinitionParser()); } } diff --git a/mockns-jmock/src/main/resources/META-INF/spring.handlers b/mockns-jmock/src/main/resources/META-INF/spring.handlers index 9832106..ce4dafc 100644 --- a/mockns-jmock/src/main/resources/META-INF/spring.handlers +++ b/mockns-jmock/src/main/resources/META-INF/spring.handlers @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews +# Copyright 2009-2011 Brian Matthews # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. http\://mockns.btmatthews.com/schema/jmock=com.btmatthews.mockns.jmock.NamespaceHandler \ No newline at end of file diff --git a/mockns-jmock/src/main/resources/META-INF/spring.schemas b/mockns-jmock/src/main/resources/META-INF/spring.schemas index 915469c..6ebcffa 100644 --- a/mockns-jmock/src/main/resources/META-INF/spring.schemas +++ b/mockns-jmock/src/main/resources/META-INF/spring.schemas @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews +# Copyright 2009-2011 Brian Matthews # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. http\://mockns.btmatthews.com/schema/jmock/jmock.xsd=com/btmatthews/mockns/jmock/jmock.xsd \ No newline at end of file diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java index c78e604..c7698c0 100644 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java @@ -1,31 +1,31 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock.test; /** * Interface to be mocked during testing. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public interface Dependency { /** * Operation to be mocked during testing. */ void doSomething(); } diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java index 73791cd..85414de 100644 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java @@ -1,49 +1,49 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock.test; import org.springframework.beans.factory.annotation.Autowired; /** * Simple service used to test mocks. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class Service { /** * The mock object is injected. */ @Autowired private Dependency testDependency; /** * The default constructor. */ public Service() { } /** * Operation to test the mock object invocation. */ public void doSomething() { this.testDependency.doSomething(); } } diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java index 6a24056..0f8b391 100644 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java @@ -1,77 +1,77 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock.test; import org.jmock.Expectations; import org.jmock.Mockery; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * Unit test the jMock implementation for MockNS. * * @author <a href="mailto:[email protected]">[email protected]</a> * @version 0.1.0 * */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration public final class TestMockNamespace { /** * Used to test the mocked object. */ @Autowired private Service service; /** * The mocked object. */ @Autowired private Dependency dependency; /** * The context for the mocked object. */ @Autowired private Mockery mockery; /** * The default constructor. */ public TestMockNamespace() { } /** * Test the mocked object. */ @Test public void test() { this.mockery.checking(new Expectations() { { allowing(TestMockNamespace.this.dependency).doSomething(); } }); this.service.doSomething(); } } diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java index d28eccb..3b767f7 100644 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java @@ -1,77 +1,77 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock.test; import org.jmock.Expectations; import org.jmock.Mockery; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * Unit test the jMock implementation for MockNS. * * @author <a href="mailto:[email protected]">[email protected]</a> * @version 0.1.0 * */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration public final class TestMockNamespaceWithAnonymousBean { /** * Used to test the mocked object. */ @Autowired private Service service; /** * The mocked object. */ @Autowired private Dependency dependency; /** * The context for the mocked object. */ @Autowired private Mockery mockery; /** * The default constructor. */ public TestMockNamespaceWithAnonymousBean() { } /** * Test the mocked object. */ @Test public void test() { this.mockery.checking(new Expectations() { { allowing(TestMockNamespaceWithAnonymousBean.this.dependency).doSomething(); } }); this.service.doSomething(); } } diff --git a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml deleted file mode 100644 index afbef5a..0000000 --- a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml +++ /dev/null @@ -1,19 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:mockns="http://mockns.btmatthews.com/schema/jmock" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans - http://www.springframework.org/schema/beans/spring-beans.xsd - http://mockns.btmatthews.com/schema/jmock - http://mockns.btmatthews.com/schema/jmock/jmock.xsd"> - - <mockns:mockery id="mockery" /> - - <mockns:mock id="dependency" - object-class="com.btmatthews.mockns.jmock.test.Dependency" - mockery="mockery" /> - - <bean id="service" class="com.btmatthews.mockns.jmock.test.Service" /> - -</beans> \ No newline at end of file diff --git a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean-context.xml b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean-context.xml deleted file mode 100644 index ddbe8aa..0000000 --- a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean-context.xml +++ /dev/null @@ -1,19 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:mockns="http://mockns.btmatthews.com/schema/jmock" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans - http://www.springframework.org/schema/beans/spring-beans.xsd - http://mockns.btmatthews.com/schema/jmock - http://mockns.btmatthews.com/schema/jmock/jmock.xsd"> - - <mockns:mockery id="mockery" /> - - <mockns:mock - object-class="com.btmatthews.mockns.jmock.test.Dependency" - mockery="mockery" /> - - <bean class="com.btmatthews.mockns.jmock.test.Service" /> - -</beans> \ No newline at end of file diff --git a/mockns-mockito/.classpath b/mockns-mockito/.classpath index 7c3d14f..3c96d64 100644 --- a/mockns-mockito/.classpath +++ b/mockns-mockito/.classpath @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" output="target/classes" path="src/main/java"/> <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5"/> + <classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"/> <classpathentry kind="output" path="target/classes"/> </classpath> diff --git a/mockns-mockito/.project b/mockns-mockito/.project index 59f6c8a..687cee4 100644 --- a/mockns-mockito/.project +++ b/mockns-mockito/.project @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="UTF-8"?> <projectDescription> <name>mockns-mockito</name> <comment></comment> <projects> </projects> <buildSpec> <buildCommand> <name>org.eclipse.wst.common.project.facet.core.builder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.eclipse.jdt.core.javabuilder</name> <arguments> </arguments> </buildCommand> <buildCommand> <name>org.maven.ide.eclipse.maven2Builder</name> <arguments> </arguments> </buildCommand> + <buildCommand> + <name>org.eclipse.m2e.core.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> </buildSpec> <natures> + <nature>org.eclipse.m2e.core.maven2Nature</nature> <nature>org.eclipse.jdt.core.javanature</nature> <nature>org.maven.ide.eclipse.maven2Nature</nature> <nature>org.eclipse.wst.common.project.facet.core.nature</nature> </natures> </projectDescription> diff --git a/mockns-mockito/.settings/org.eclipse.jdt.core.prefs b/mockns-mockito/.settings/org.eclipse.jdt.core.prefs index e6b4341..e55972a 100644 --- a/mockns-mockito/.settings/org.eclipse.jdt.core.prefs +++ b/mockns-mockito/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,6 @@ -#Tue Sep 15 21:35:48 BST 2009 +#Sun Aug 14 03:24:00 BST 2011 eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5 +org.eclipse.jdt.core.compiler.compliance=1.5 +org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning +org.eclipse.jdt.core.compiler.source=1.5 diff --git a/mockns-mockito/pom.xml b/mockns-mockito/pom.xml index d80b84c..31ae34c 100644 --- a/mockns-mockito/pom.xml +++ b/mockns-mockito/pom.xml @@ -1,54 +1,53 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright 2009-2011 Brian Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> - <version>0.1.0-SNAPSHOT</version> + <version>1.0.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-mockito</artifactId> <name>MockNS for Mockito</name> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project> \ No newline at end of file diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java index 3bd7cd9..1e55bd0 100644 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java @@ -1,82 +1,82 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** * The bean definition parser for the Mockito mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class MockBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { /** * The default constructor. */ public MockBeanDefinitionParser() { } /** * Parse an XML bean definition. * * @param element * The element that defines the bean. * @param builder * Helps build the bean definition. * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) */ @Override protected void doParse(final Element element, final BeanDefinitionBuilder builder) { final String objectClass = element.getAttribute("object-class"); builder.addConstructorArgValue(objectClass); } /** * Get class of the factory used to create the beans. * * @param element * The element that defines the bean. * @return Always returns {@link MockFactoryBean}. * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) */ - @SuppressWarnings("unchecked") + @SuppressWarnings("rawtypes") @Override protected Class getBeanClass(final Element element) { return MockFactoryBean.class; } /** * Indicate that the bean factory should generate an identifier for the bean * if one is not present. * * @return Always returns <code>true</code> * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() */ @Override protected boolean shouldGenerateIdAsFallback() { return true; } } diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java index 9ebcd84..d9752cc 100644 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java @@ -1,86 +1,79 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito; import org.mockito.Mockito; import org.springframework.beans.factory.FactoryBean; /** * The bean definition parser for the EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ -public final class MockFactoryBean - implements FactoryBean +public final class MockFactoryBean<T> + implements FactoryBean<T> { /** * The interface or class to be mocked. */ - @SuppressWarnings("unchecked") - private Class objectClass; + private Class<T> objectClass; /** * The constructor. * * @param clazz * The interface or class to be mocked. */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class clazz) + public MockFactoryBean(final Class<T> clazz) { this.objectClass = clazz; } /** * Create the mock object. * * @return The mock object. * @see org.springframework.beans.factory.FactoryBean#getObject() */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() + public T getObject() { return Mockito.mock(this.objectClass); } /** * Return the interface or class that will be mocked. * * @return The interface or class. * @see org.springframework.beans.factory.FactoryBean#getObjectType() */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() + public Class<T> getObjectType() { return this.objectClass; } /** * Indicate that mock objects created by this factory are singletons. * * @return Always returns <code>true</code>. * @see org.springframework.beans.factory.FactoryBean#isSingleton() */ - @Override public boolean isSingleton() { return true; } } diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java index 2aea3b8..adbc0bc 100644 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java @@ -1,48 +1,47 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** * The name-space hander for the Mockito. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class NamespaceHandler extends NamespaceHandlerSupport { /** * The default constructor. */ public NamespaceHandler() { } /** * Register the bean definition parsers for the name-space. * * @see org.springframework.beans.factory.xml.NamespaceHandler#init() */ - @Override public void init() { this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); } } diff --git a/mockns-mockito/src/main/resources/META-INF/spring.handlers b/mockns-mockito/src/main/resources/META-INF/spring.handlers index 765c0e3..812fa81 100644 --- a/mockns-mockito/src/main/resources/META-INF/spring.handlers +++ b/mockns-mockito/src/main/resources/META-INF/spring.handlers @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews +# Copyright 2009-2011 Brian Matthews # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. http\://mockns.btmatthews.com/schema/mockito=com.btmatthews.mockns.mockito.NamespaceHandler \ No newline at end of file diff --git a/mockns-mockito/src/main/resources/META-INF/spring.schemas b/mockns-mockito/src/main/resources/META-INF/spring.schemas index f8838e8..6a59929 100644 --- a/mockns-mockito/src/main/resources/META-INF/spring.schemas +++ b/mockns-mockito/src/main/resources/META-INF/spring.schemas @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews +# Copyright 2009-2011 Brian Matthews # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. http\://mockns.btmatthews.com/schema/mockito/mockito.xsd=com/btmatthews/mockns/mockito/mockito.xsd \ No newline at end of file diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java index ebb9b49..7c91d2a 100644 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java @@ -1,31 +1,31 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito.test; /** * Interface to be mocked during testing. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public interface Dependency { /** * Operation to be mocked during testing. */ void doSomething(); } diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java index ce3e45c..f9d5576 100644 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java @@ -1,49 +1,49 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito.test; import org.springframework.beans.factory.annotation.Autowired; /** * Simple service used to test mocks. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version 0.1.0 */ public final class Service { /**s * The mock object is injected. */ @Autowired private Dependency testDependency; /** * The default constructor. */ public Service() { } /** * Operation to test the mock object invocation. */ public void doSomething() { this.testDependency.doSomething(); } } diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java index 9fcd6c2..3180a68 100644 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java @@ -1,64 +1,64 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito.test; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mockito; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * Unit test the Mockito implementation for MockNS. * * @author <a href="mailto:[email protected]">[email protected]</a> * @version 0.1.0 */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration public final class TestMockNamespace { /** * Used to test the mocked object. */ @Autowired private Service service; /** * The mocked object. */ @Autowired private Dependency dependency; /** * The default constructor. */ public TestMockNamespace() { } /** * Test the mocked object. */ @Test public void test() { this.service.doSomething(); Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); } } diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java index 0e52b57..0a30123 100644 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java @@ -1,64 +1,64 @@ /* - * Copyright (c) 2009 Brian Thomas Matthews + * Copyright 2009-2011 Brian Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito.test; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mockito; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * Unit test the Mockito implementation for MockNS. * * @author <a href="mailto:[email protected]">[email protected]</a> * @version 0.1.0 */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration public final class TestMockNamespaceWithAnonymousBean { /** * Used to test the mocked object. */ @Autowired private Service service; /** * The mocked object. */ @Autowired private Dependency dependency; /** * The default constructor. */ public TestMockNamespaceWithAnonymousBean() { } /** * Test the mocked object. */ @Test public void test() { this.service.doSomething(); Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); } } diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml index 5743236..3d0eabe 100644 --- a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml @@ -1,31 +1,31 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright 2009-2011 Brian Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://mockns.btmatthews.com/schema/mockito http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> <mockns:mock object-class="com.btmatthews.mockns.mockito.test.Dependency" /> <bean class="com.btmatthews.mockns.mockito.test.Service" /> </beans> \ No newline at end of file diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml index e356f2f..75bfb4e 100644 --- a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml @@ -1,31 +1,31 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright 2009-2011 Brian Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://mockns.btmatthews.com/schema/mockito http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> <mockns:mock id="dependency" object-class="com.btmatthews.mockns.mockito.test.Dependency" /> <bean id="service" class="com.btmatthews.mockns.mockito.test.Service" /> </beans> \ No newline at end of file diff --git a/pom.xml b/pom.xml index e051af0..15dfe51 100644 --- a/pom.xml +++ b/pom.xml @@ -1,283 +1,236 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - Copyright (c) 2009 Brian Thomas Matthews + Copyright (c) 2009-2011 Brian Thomas Matthews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <packaging>pom</packaging> <name>MockNS</name> - <version>0.1.0-SNAPSHOT</version> + <version>1.0.0-SNAPSHOT</version> <modules> <module>mockns-easymock</module> <module>mockns-jmock</module> <module>mockns-mockito</module> </modules> <description></description> <url>http://mockns.btmatthews.com</url> <inceptionYear>2009</inceptionYear> <licenses> <license> <name>Apache 2</name> <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> <distribution>repo</distribution> </license> </licenses> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> - <version>2.1</version> + <version>2.3.2</version> </plugin> <plugin> - <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> - <version>2.3</version> + <version>2.6</version> <configuration> <configLocation>../checkstyle.xml</configLocation> <encoding>UTF-8</encoding> </configuration> </plugin> <plugin> - <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> - <version>2.4</version> + <version>2.5</version> <configuration> <aggregate>true</aggregate> <linkXRef>true</linkXRef> <sourceEncoding>UTF-8</sourceEncoding> - <targetJdk>1.6</targetJdk> + <targetJdk>1.5</targetJdk> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>taglist-maven-plugin</artifactId> - <version>2.3</version> + <version>2.4</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jdepend-maven-plugin</artifactId> <version>2.0-beta-2</version> </plugin> <plugin> - <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> - <version>2.4.3</version> + <version>2.9</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> - <version>2.3</version> + <version>2.5.1</version> <configuration> <quiet>true</quiet> </configuration> </plugin> <plugin> - <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jxr-plugin</artifactId> - <version>2.1</version> + <version>2.3</version> <configuration> <aggregate>true</aggregate> <outputEncoding>UTF-8</outputEncoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.5</version> + <version>2.8</version> <configuration> <executions> <execution> <goals> <goal>aggregate</goal> <goal>test-aggregate</goal> </goals> <configuration> <encoding>UTF-8</encoding> </configuration> </execution> </executions> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>dashboard-maven-plugin</artifactId> <version>1.0.0-beta-1</version> </plugin> </plugins> </reporting> <organization> - <name>Brian Thomas Matthews</name> + <name>Brian Matthews</name> <url>http://btmatthews.com</url> </organization> - <issueManagement> - <system>Trac</system> - <url>https://trac.btmatthews.com/projects/mockns</url> - </issueManagement> - <ciManagement> - <system>Continuum</system> - <url>https://continuum.btmatthews.com</url> - </ciManagement> <developers> <developer> <id>bmatthews68</id> <name>Brian Matthews</name> <email>[email protected]</email> <url>http://brian.btmatthews.com</url> <organization>btmatthews.com</organization> <organizationUrl>http://btmatthews.com</organizationUrl> <roles> <role>developer</role> </roles> <timezone>0</timezone> </developer> </developers> <build> <pluginManagement> <plugins> <plugin> - <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-plugin-plugin</artifactId> - <version>2.5</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-clean-plugin</artifactId> - <version>2.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-resources-plugin</artifactId> - <version>2.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <version>2.2</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-war-plugin</artifactId> - <version>2.1-beta-1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-dependency-plugin</artifactId> - <version>2.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-deploy-plugin</artifactId> - <version>2.4</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-install-plugin</artifactId> - <version>2.3</version> + <version>2.8</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> - <version>2.0.1</version> + <version>3.0</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> - <version>2.0.2</version> + <version>2.3.2</version> <configuration> - <source>1.6</source> - <target>1.6</target> + <source>1.5</source> + <target>1.5</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> - <version>2.4.3</version> + <version>2.9</version> </plugin> </plugins> </pluginManagement> </build> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> - <version>2.5.6</version> + <version>3.0.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> - <version>2.5.6</version> + <version>3.0.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> - <version>2.5.6</version> + <version>3.0.5.RELEASE</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> - <version>2.5.2</version> + <version>3.0</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> - <version>2.4</version> + <version>3.0</version> </dependency> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> <version>2.5.1</version> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> - <version>1.8.0</version> + <version>1.8.5</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> - <version>4.4</version> + <version>4.8.2</version> </dependency> </dependencies> </dependencyManagement> + <issueManagement> + <url>https://github.com/bmatthews68/ldap-maven-plugin/issues</url> + <system>GitHub</system> + </issueManagement> <distributionManagement> <site> - <id>btmatthews.com</id> - <name>MockNS Site</name> - <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> + <id>gh-pages</id> + <url>gitsite:[email protected]/bmatthews68/ldap-maven-plugin.git</url> </site> <repository> - <id>btmatthews.com</id> - <name>Release Repository</name> - <url>scp://btmatthews.com/var/www/repository.btmatthews.com</url> + <id>releases.sonatype</id> + <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url> </repository> <snapshotRepository> - <id>btmatthews.com</id> - <name>Snapshot Repository</name> - <url>scp://btmatthews.com/var/www/snapshot.btmatthews.com</url> + <id>snapshots.sonatype</id> + <url>https://oss.sonatype.org/content/repositories/snapshots</url> </snapshotRepository> </distributionManagement> <scm> <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> <url>http://github.com/bmatthews68/MockNS</url> </scm> </project> \ No newline at end of file
bmatthews68/MockNS
04d2212b9e4968d02b4d907addcad1e0666614dc
Checking in work in progress
diff --git a/checkstyle.xml b/checkstyle.xml index 8aa5dcc..79355c0 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -1,174 +1,188 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> - +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <module name="Checker"> <module name="SuppressionCommentFilter" /> <module name="PackageHtml" /> <module name="TreeWalker"> <module name="FileContentsHolder" /> <module name="JavadocType"> <property name="authorFormat" value="^&lt;a href=&quot;mailto:([0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})&quot;&gt;([a-zA-Z.\s']{1,50})&lt;/a&gt;$" /> <property name="versionFormat" value="^((\d)?(\d{1})(\.{1})(\d)?(\d{1})){1,2}$" /> </module> <module name="JavadocMethod" /> <module name="JavadocVariable" /> <module name="JavadocStyle"> <property name="checkEmptyJavadoc" value="true" /> </module> <module name="AbstractClassName" /> <module name="ConstantName" /> <module name="LocalFinalVariableName" /> <module name="LocalVariableName" /> <module name="MemberName" /> <module name="MethodName" /> <module name="PackageName" /> <module name="ParameterName" /> <module name="StaticVariableName" /> <module name="TypeName" /> <module name="TypeName"> <property name="format" value="^I[a-zA-Z0-9]*$" /> <property name="tokens" value="INTERFACE_DEF" /> </module> <!-- <module name="RegexpHeader"> <property name="header" value="^/\*$\n^ \* Copyright \(c\) 2006-2008 TerraNua Limited\.$\n^ \* All rights reserved, worldwide\.$\n^ \*$\n^ \* This software and all information contained herein is the property of$\n^ \* TerraNua Limited\. Any dissemination, disclosure, use, or reproduction$\n^ \* of this material for any reason inconsistent with the express purpose$\n^ \* for which it has been disclosed is strictly forbidden\.$\n^ \*/$\n^$\n^package\n^$\n" /> <property name="multiLines" value="12,15" /> </module> --> <module name="AvoidStarImport" /> <module name="IllegalImport" /> <module name="RedundantImport" /> <module name="UnusedImports" /> <module name="ImportOrder"> <property name="groups" value="java,junit,javax,org,net,com" /> <property name="ordered" value="true" /> <property name="separated" value="true" /> </module> <!-- <module name="ImportControl"> <property name="file" value="c:/brian/import-control.xml"/> </module> --> <module name="ExecutableStatementCount" /> <module name="FileLength" /> <module name="LineLength"> <property name="max" value="132" /> </module> <module name="MethodLength" /> <module name="AnonInnerLength" /> <module name="ParameterNumber" /> <module name="EmptyForInitializerPad"> <property name="option" value="nospace" /> </module> <module name="EmptyForIteratorPad" /> <module name="MethodParamPad" /> <module name="NoWhitespaceAfter"> <!-- Default tokens and additional GENERIC_START --> <property name="tokens" value="ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS, TYPECAST, GENERIC_START" /> </module> <module name="NoWhitespaceBefore"> <!-- Default tokens and additional GENERIC_START and GENERIC_END --> <property name="tokens" value="SEMI, POST_DEC, POST_INC, GENERIC_START, GENERIC_END" /> </module> <module name="WhitespaceAfter"> <!-- Default tokens and additional GENERIC_END --> <property name="tokens" value="COMMA, SEMI, GENERIC_END" /> </module> <module name="WhitespaceAround"> <!-- Default tokens without GENERIC_START and GENERIC_END --> <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND, WILDCARD_TYPE" /> </module> <module name="OperatorWrap" /> <module name="ParenPad" /> <module name="TypecastParenPad" /> <module name="TabCharacter" /> <module name="ModifierOrder" /> <module name="RedundantModifier" /> <module name="EmptyBlock"> <property name="option" value="stmt" /> </module> <module name="LeftCurly"> <property name="option" value="nl" /> </module> <module name="NeedBraces" /> <module name="RightCurly"> <property name="option" value="alone" /> </module> <module name="AvoidNestedBlocks"> <property name="allowInSwitchCase" value="true" /> </module> <module name="ArrayTrailingComma" /> <module name="AvoidInlineConditionals" /> <module name="CovariantEquals" /> <module name="DoubleCheckedLocking" /> <module name="EmptyStatement" /> <module name="EqualsHashCode" /> <module name="FinalLocalVariable" /> <module name="HiddenField" /> <module name="IllegalInstantiation"> <property name="classes" value="java.lang.Boolean" /> </module> <module name="IllegalToken"> <property name="tokens" value="LITERAL_NATIVE" /> </module> <module name="InnerAssignment" /> <module name="MagicNumber" /> <module name="MissingSwitchDefault" /> <module name="ModifiedControlVariable" /> <module name="RedundantThrows" /> <module name="SimplifyBooleanExpression" /> <module name="SimplifyBooleanReturn" /> <module name="StringLiteralEquality" /> <module name="NestedIfDepth" /> <module name="NestedTryDepth" /> <module name="SuperClone" /> <module name="SuperFinalize" /> <module name="IllegalCatch" /> <module name="IllegalThrows" /> <module name="PackageDeclaration" /> <module name="JUnitTestCase" /> <module name="ReturnCount" /> <module name="IllegalType" /> <module name="DeclarationOrder" /> <module name="ParameterAssignment" /> <module name="ExplicitInitialization" /> <module name="DefaultComesLast" /> <module name="MissingCtor" /> <module name="FallThrough" /> <module name="MultipleStringLiterals" /> <module name="MultipleVariableDeclarations" /> <module name="RequireThis" /> <module name="UnnecessaryParentheses" /> <module name="VisibilityModifier" /> <module name="FinalClass" /> <module name="InterfaceIsType" /> <module name="HideUtilityClassConstructor" /> <module name="DesignForExtension" /> <module name="MutableException" /> <!-- <module name="ThrowsCount"/> --> <module name="BooleanExpressionComplexity" /> <module name="ClassDataAbstractionCoupling" /> <module name="ClassFanOutComplexity" /> <module name="CyclomaticComplexity" /> <module name="NPathComplexity" /> <module name="JavaNCSS" /> <module name="TodoComment" /> <module name="UncommentedMain" /> <module name="UpperEll" /> <module name="ArrayTypeStyle" /> <module name="FinalParameters" /> <module name="DescendantToken" /> <module name="Indentation" /> <module name="TrailingComment" /> </module> <!-- <module name="StrictDuplicateCode"/> --> <!-- <module name="NewlineAtEndOfFile"/> --> </module> diff --git a/mockns-easymock/pom.xml b/mockns-easymock/pom.xml index d861d80..ac7bf51 100644 --- a/mockns-easymock/pom.xml +++ b/mockns-easymock/pom.xml @@ -1,43 +1,58 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <version>0.1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-easymock</artifactId> <name>MockNS for EasyMock</name> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project> \ No newline at end of file diff --git a/mockns-jmock/pom.xml b/mockns-jmock/pom.xml index d30ec98..a484808 100644 --- a/mockns-jmock/pom.xml +++ b/mockns-jmock/pom.xml @@ -1,39 +1,54 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <version>0.1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-jmock</artifactId> <name>MockNS for jMock</name> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> </dependency> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project> \ No newline at end of file diff --git a/mockns-mockito/pom.xml b/mockns-mockito/pom.xml index c0d8260..d80b84c 100644 --- a/mockns-mockito/pom.xml +++ b/mockns-mockito/pom.xml @@ -1,39 +1,54 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <version>0.1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns-mockito</artifactId> <name>MockNS for Mockito</name> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project> \ No newline at end of file diff --git a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd index 46f92b0..1742595 100644 --- a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd +++ b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd @@ -1,30 +1,45 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <xsd:schema xmlns="http://mockns.btmatthews.com/schema/mockito" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans" targetNamespace="http://mockns.btmatthews.com/schema/mockito" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xsd:import namespace="http://www.springframework.org/schema/beans" /> <xsd:element name="mock"> <xsd:annotation> <xsd:documentation><![CDATA[ Create an Mockito mock bean. ]]></xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="beans:identifiedType"> <xsd:attribute name="object-class" type="xsd:string" use="required" /> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:schema> \ No newline at end of file diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml index 037ed19..5743236 100644 --- a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml @@ -1,16 +1,31 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://mockns.btmatthews.com/schema/mockito http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> <mockns:mock object-class="com.btmatthews.mockns.mockito.test.Dependency" /> <bean class="com.btmatthews.mockns.mockito.test.Service" /> </beans> \ No newline at end of file diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml index ce8aade..e356f2f 100644 --- a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml @@ -1,16 +1,31 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://mockns.btmatthews.com/schema/mockito http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> <mockns:mock id="dependency" object-class="com.btmatthews.mockns.mockito.test.Dependency" /> <bean id="service" class="com.btmatthews.mockns.mockito.test.Service" /> </beans> \ No newline at end of file diff --git a/pom.xml b/pom.xml index 7d539f0..e051af0 100644 --- a/pom.xml +++ b/pom.xml @@ -1,268 +1,283 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <packaging>pom</packaging> <name>MockNS</name> <version>0.1.0-SNAPSHOT</version> <modules> <module>mockns-easymock</module> <module>mockns-jmock</module> <module>mockns-mockito</module> </modules> <description></description> <url>http://mockns.btmatthews.com</url> <inceptionYear>2009</inceptionYear> <licenses> <license> <name>Apache 2</name> <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> <distribution>repo</distribution> </license> </licenses> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.3</version> <configuration> <configLocation>../checkstyle.xml</configLocation> <encoding>UTF-8</encoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> <version>2.4</version> <configuration> <aggregate>true</aggregate> <linkXRef>true</linkXRef> <sourceEncoding>UTF-8</sourceEncoding> <targetJdk>1.6</targetJdk> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>taglist-maven-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jdepend-maven-plugin</artifactId> <version>2.0-beta-2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>2.4.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.3</version> <configuration> <quiet>true</quiet> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jxr-plugin</artifactId> <version>2.1</version> <configuration> <aggregate>true</aggregate> <outputEncoding>UTF-8</outputEncoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.5</version> <configuration> <executions> <execution> <goals> <goal>aggregate</goal> <goal>test-aggregate</goal> </goals> <configuration> <encoding>UTF-8</encoding> </configuration> </execution> </executions> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>dashboard-maven-plugin</artifactId> <version>1.0.0-beta-1</version> </plugin> </plugins> </reporting> <organization> <name>Brian Thomas Matthews</name> <url>http://btmatthews.com</url> </organization> <issueManagement> <system>Trac</system> <url>https://trac.btmatthews.com/projects/mockns</url> </issueManagement> <ciManagement> <system>Continuum</system> <url>https://continuum.btmatthews.com</url> </ciManagement> <developers> <developer> <id>bmatthews68</id> <name>Brian Matthews</name> <email>[email protected]</email> <url>http://brian.btmatthews.com</url> <organization>btmatthews.com</organization> <organizationUrl>http://btmatthews.com</organizationUrl> <roles> <role>developer</role> </roles> <timezone>0</timezone> </developer> </developers> <build> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-plugin-plugin</artifactId> <version>2.5</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-clean-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.1-beta-1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-deploy-plugin</artifactId> <version>2.4</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>2.0.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>2.0.2</version> <configuration> <source>1.6</source> <target>1.6</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.4.3</version> </plugin> </plugins> </pluginManagement> </build> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> <version>2.5.2</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> <version>2.4</version> </dependency> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> <version>2.5.1</version> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> <version>1.8.0</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.4</version> </dependency> </dependencies> </dependencyManagement> <distributionManagement> <site> <id>btmatthews.com</id> <name>MockNS Site</name> <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> </site> <repository> <id>btmatthews.com</id> <name>Release Repository</name> <url>scp://btmatthews.com/var/www/repository.btmatthews.com</url> </repository> <snapshotRepository> <id>btmatthews.com</id> <name>Snapshot Repository</name> <url>scp://btmatthews.com/var/www/snapshot.btmatthews.com</url> </snapshotRepository> </distributionManagement> <scm> <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> <url>http://github.com/bmatthews68/MockNS</url> </scm> </project> \ No newline at end of file
bmatthews68/MockNS
64ad7c88ac32ad130f0ac30e8ad96270b38d6e21
Additional unit tests and site configuration
diff --git a/mockns-easymock/src/site/apt/usage.apt b/mockns-easymock/src/site/apt/usage.apt new file mode 100644 index 0000000..ecb0018 --- /dev/null +++ b/mockns-easymock/src/site/apt/usage.apt @@ -0,0 +1,65 @@ + ------ + Usage + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +Usage + + The following steps describe the usage of the Spring name-space support for Easy Mock. + +* Step 1 - Dependency + + Add the following dependency to your POM. + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-easymock</artifactId> + <version>${pom.version}</version> +</dependency> +------------------- + +* Step 2 - Include Namespace in your XML + +------------------- +<?xml version="1.0" encoding="UTF-8"?> +<beans + xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/easymock" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/easymock + http://mockns.btmatthews.com/schema/easymock/easymock.xsd"> + . + . + . +</beans> +------------------- + +* Step 3 - Declare your mock object bean + +------------------- +<mockns:mock + id="dependency" + object-class="com.btmatthews.mockns.easymock.test.Dependency" /> +------------------- diff --git a/mockns-easymock/src/site/site.xml b/mockns-easymock/src/site/site.xml new file mode 100644 index 0000000..602d75f --- /dev/null +++ b/mockns-easymock/src/site/site.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="ISO-8859-1" ?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project name="${project.name}"> + <bannerLeft> + <name>MockNS</name> + <href>http://mockns.btmatthews.com</href> + </bannerLeft> + <publishDate format="dd MMM yyyy" position="left" /> + <version position="left" /> + <body> + <links> + <item name="Spring" href="http://www.springframework.org/" /> + <item name="EasyMock" href="http://easymock.org/" /> + <item name="jMock" href="http://www.jmock.org/" /> + <item name="Mockito" href="http://mockito.org/" /> + <item name="Maven 2" href="http://maven.apache.org/" /> + <item name="GitHub" href="http://github.com/" /> + </links> + <menu name="Overview"> + <item name="Introduction" href="index.html" /> + <item name="Usage" href="usage.html" /> + </menu> + <menu ref="parent" /> + <menu ref="reports" /> + </body> + <poweredBy> + <logo name="Maven" href="http://maven.apache.org/" img="http://maven.apache.org/images/logos/maven-feather.png"/> + </poweredBy> +</project> \ No newline at end of file diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java new file mode 100644 index 0000000..501f7b8 --- /dev/null +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock.test; + +import org.easymock.classextension.EasyMock; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Unit test the Easy Mock implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public final class TestMockNamespaceWithAnonymousBean +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The default constructor. + */ + public TestMockNamespaceWithAnonymousBean() + { + } + + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.dependency.doSomething(); + EasyMock.expectLastCall(); + EasyMock.replay(this.dependency); + this.service.doSomething(); + EasyMock.verify(this.dependency); + } +} diff --git a/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean-context.xml b/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean-context.xml new file mode 100644 index 0000000..71d45b0 --- /dev/null +++ b/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespaceWithAnonymousBean-context.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/easymock" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/easymock + http://mockns.btmatthews.com/schema/easymock/easymock.xsd"> + + <mockns:mock + object-class="com.btmatthews.mockns.easymock.test.Dependency" /> + + <bean class="com.btmatthews.mockns.easymock.test.Service" /> + +</beans> \ No newline at end of file diff --git a/mockns-jmock/src/site/apt/usage.apt b/mockns-jmock/src/site/apt/usage.apt new file mode 100644 index 0000000..ab56b11 --- /dev/null +++ b/mockns-jmock/src/site/apt/usage.apt @@ -0,0 +1,38 @@ + ------ + Usage + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +Usage + + The following steps describe the usage of the Spring name-space support for Easy Mock. + +* Step 1 - Dependency + + Add the following dependency to your POM. + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-jmock</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java new file mode 100644 index 0000000..d28eccb --- /dev/null +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean.java @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock.test; + +import org.jmock.Expectations; +import org.jmock.Mockery; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Unit test the jMock implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + * + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public final class TestMockNamespaceWithAnonymousBean +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The context for the mocked object. + */ + @Autowired + private Mockery mockery; + + /** + * The default constructor. + */ + public TestMockNamespaceWithAnonymousBean() + { + } + + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.mockery.checking(new Expectations() + { + { + allowing(TestMockNamespaceWithAnonymousBean.this.dependency).doSomething(); + } + }); + this.service.doSomething(); + } +} diff --git a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean-context.xml b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean-context.xml new file mode 100644 index 0000000..ddbe8aa --- /dev/null +++ b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespaceWithAnonymousBean-context.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/jmock" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/jmock + http://mockns.btmatthews.com/schema/jmock/jmock.xsd"> + + <mockns:mockery id="mockery" /> + + <mockns:mock + object-class="com.btmatthews.mockns.jmock.test.Dependency" + mockery="mockery" /> + + <bean class="com.btmatthews.mockns.jmock.test.Service" /> + +</beans> \ No newline at end of file diff --git a/mockns-mockito/src/site/apt/usage.apt b/mockns-mockito/src/site/apt/usage.apt new file mode 100644 index 0000000..71d9c09 --- /dev/null +++ b/mockns-mockito/src/site/apt/usage.apt @@ -0,0 +1,38 @@ + ------ + Usage + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +Usage + + The following steps describe the usage of the Spring name-space support for Easy Mock. + +* Step 1 - Dependency + + Add the following dependency to your POM. + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-mockito</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java new file mode 100644 index 0000000..0e52b57 --- /dev/null +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean.java @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito.test; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mockito; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Unit test the Mockito implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public final class TestMockNamespaceWithAnonymousBean +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The default constructor. + */ + public TestMockNamespaceWithAnonymousBean() + { + } + + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.service.doSomething(); + Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); + } +} diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml new file mode 100644 index 0000000..ce8aade --- /dev/null +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespaceWithAnonymousBean-context.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/mockito + http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> + + <mockns:mock id="dependency" + object-class="com.btmatthews.mockns.mockito.test.Dependency" /> + + <bean id="service" class="com.btmatthews.mockns.mockito.test.Service" /> + +</beans> \ No newline at end of file diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt index 56311ea..3f231ae 100644 --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt @@ -1,54 +1,31 @@ ------ Introduction ------ Brian Matthews ------ - 2009-09-25 + 2009-09-28 ------ ~~ Copyright (c) 2009 Brian Thomas Matthews ~~ ~~ Licensed under the Apache License, Version 2.0 (the "License"); ~~ you may not use this file except in compliance with the License. ~~ You may obtain a copy of the License at ~~ ~~ http://www.apache.org/licenses/LICENSE-2.0 ~~ ~~ Unless required by applicable law or agreed to in writing, software ~~ distributed under the License is distributed on an "AS IS" BASIS, ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ~~ See the License for the specific language governing permissions and ~~ limitations under the License. MockNS - MockNS provides {{{http://www.springframework.org}Spring}} name-space support for - creating mock objects using following frameworks: + MockNS provides {{{http://www.springframework.org}Spring}} name-space support to + creating and configure mock objects for the following frameworks: - * EasyMock - * jMock - * Mockito. - -* MockNS for EasyMock - - -* MockNS for jMock - -------------------- -<dependency> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-jmock</artifactId> - <version>0.1.0-SNAPSHOT</version> -</dependency> -------------------- - -* MockNS for Mockito - -------------------- -<dependency> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-mockito</artifactId> - <version>0.1.0-SNAPSHOT</version> -</dependency> -------------------- + * {{{http://easymock.org}EasyMock}} + * {{{http://www.jmock.org}jMock}} + * {{{http://mockito.org}Mockito}} diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt index 456b6a0..ec1545a 100644 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -1,25 +1,25 @@ ------ Usage ------ Brian Matthews ------ - 2009-09-25 + 2009-09-28 ------ ~~ Copyright (c) 2009 Brian Thomas Matthews ~~ ~~ Licensed under the Apache License, Version 2.0 (the "License"); ~~ you may not use this file except in compliance with the License. ~~ You may obtain a copy of the License at ~~ ~~ http://www.apache.org/licenses/LICENSE-2.0 ~~ ~~ Unless required by applicable law or agreed to in writing, software ~~ distributed under the License is distributed on an "AS IS" BASIS, ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ~~ See the License for the specific language governing permissions and ~~ limitations under the License. Usage
bmatthews68/MockNS
9e6212747c95543142ca7ee885cfd662d0cc99e0
CR/LF clean-up
diff --git a/.classpath b/.classpath old mode 100755 new mode 100644 index 0469885..25df935 --- a/.classpath +++ b/.classpath @@ -1,6 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> -<classpath> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> - <classpathentry kind="output" path="target/classes"/> -</classpath> +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/.project b/.project old mode 100755 new mode 100644 index de228a6..9b7d29a --- a/.project +++ b/.project @@ -1,29 +1,29 @@ -<?xml version="1.0" encoding="UTF-8"?> -<projectDescription> - <name>mockns</name> - <comment></comment> - <projects> - </projects> - <buildSpec> - <buildCommand> - <name>org.eclipse.wst.common.project.facet.core.builder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.eclipse.jdt.core.javabuilder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.maven.ide.eclipse.maven2Builder</name> - <arguments> - </arguments> - </buildCommand> - </buildSpec> - <natures> - <nature>org.eclipse.jdt.core.javanature</nature> - <nature>org.maven.ide.eclipse.maven2Nature</nature> - <nature>org.eclipse.wst.common.project.facet.core.nature</nature> - </natures> -</projectDescription> +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs old mode 100755 new mode 100644 index b77f1e6..77f127f --- a/.settings/org.eclipse.jdt.core.prefs +++ b/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,5 @@ -#Tue Sep 15 21:35:42 BST 2009 -eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +#Tue Sep 15 21:35:42 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/.settings/org.maven.ide.eclipse.prefs b/.settings/org.maven.ide.eclipse.prefs old mode 100755 new mode 100644 index 8be9cf7..55f0968 --- a/.settings/org.maven.ide.eclipse.prefs +++ b/.settings/org.maven.ide.eclipse.prefs @@ -1,9 +1,9 @@ -#Tue Sep 15 21:35:39 BST 2009 -activeProfiles= -eclipse.preferences.version=1 -fullBuildGoals=process-test-resources -includeModules=false -resolveWorkspaceProjects=true -resourceFilterGoals=process-resources resources\:testResources -skipCompilerPlugin=true -version=1 +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/checkstyle.xml b/checkstyle.xml old mode 100755 new mode 100644 index dbe1197..8aa5dcc --- a/checkstyle.xml +++ b/checkstyle.xml @@ -1,174 +1,174 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> - -<module name="Checker"> - <module name="SuppressionCommentFilter" /> - <module name="PackageHtml" /> - <module name="TreeWalker"> - <module name="FileContentsHolder" /> - <module name="JavadocType"> - <property name="authorFormat" - value="^&lt;a href=&quot;mailto:([0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})&quot;&gt;([a-zA-Z.\s']{1,50})&lt;/a&gt;$" /> - <property name="versionFormat" - value="^((\d)?(\d{1})(\.{1})(\d)?(\d{1})){1}$" /> - </module> - <module name="JavadocMethod" /> - <module name="JavadocVariable" /> - <module name="JavadocStyle"> - <property name="checkEmptyJavadoc" value="true" /> - </module> - <module name="AbstractClassName" /> - <module name="ConstantName" /> - <module name="LocalFinalVariableName" /> - <module name="LocalVariableName" /> - <module name="MemberName" /> - <module name="MethodName" /> - <module name="PackageName" /> - <module name="ParameterName" /> - <module name="StaticVariableName" /> - <module name="TypeName" /> - <module name="TypeName"> - <property name="format" value="^I[a-zA-Z0-9]*$" /> - <property name="tokens" value="INTERFACE_DEF" /> - </module> -<!-- - <module name="RegexpHeader"> - <property name="header" - value="^/\*$\n^ \* Copyright \(c\) 2006-2008 TerraNua Limited\.$\n^ \* All rights reserved, worldwide\.$\n^ \*$\n^ \* This software and all information contained herein is the property of$\n^ \* TerraNua Limited\. Any dissemination, disclosure, use, or reproduction$\n^ \* of this material for any reason inconsistent with the express purpose$\n^ \* for which it has been disclosed is strictly forbidden\.$\n^ \*/$\n^$\n^package\n^$\n" /> - <property name="multiLines" value="12,15" /> - </module> ---> - <module name="AvoidStarImport" /> - <module name="IllegalImport" /> - <module name="RedundantImport" /> - <module name="UnusedImports" /> - <module name="ImportOrder"> - <property name="groups" - value="java,junit,javax,org,net,com" /> - <property name="ordered" value="true" /> - <property name="separated" value="true" /> - </module> - <!-- - <module name="ImportControl"> - <property name="file" value="c:/brian/import-control.xml"/> - </module> - --> - <module name="ExecutableStatementCount" /> - <module name="FileLength" /> - <module name="LineLength"> - <property name="max" value="132" /> - </module> - <module name="MethodLength" /> - <module name="AnonInnerLength" /> - <module name="ParameterNumber" /> - <module name="EmptyForInitializerPad"> - <property name="option" value="nospace" /> - </module> - <module name="EmptyForIteratorPad" /> - <module name="MethodParamPad" /> - <module name="NoWhitespaceAfter"> - <!-- Default tokens and additional GENERIC_START --> - <property name="tokens" - value="ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS, TYPECAST, GENERIC_START" /> - </module> - <module name="NoWhitespaceBefore"> - <!-- Default tokens and additional GENERIC_START and GENERIC_END --> - <property name="tokens" - value="SEMI, POST_DEC, POST_INC, GENERIC_START, GENERIC_END" /> - </module> - <module name="WhitespaceAfter"> - <!-- Default tokens and additional GENERIC_END --> - <property name="tokens" - value="COMMA, SEMI, GENERIC_END" /> - </module> - <module name="WhitespaceAround"> - <!-- Default tokens without GENERIC_START and GENERIC_END --> - <property name="tokens" - value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND, WILDCARD_TYPE" /> - </module> - <module name="OperatorWrap" /> - <module name="ParenPad" /> - <module name="TypecastParenPad" /> - <module name="TabCharacter" /> - <module name="ModifierOrder" /> - <module name="RedundantModifier" /> - <module name="EmptyBlock"> - <property name="option" value="stmt" /> - </module> - <module name="LeftCurly"> - <property name="option" value="nl" /> - </module> - <module name="NeedBraces" /> - <module name="RightCurly"> - <property name="option" value="alone" /> - </module> - <module name="AvoidNestedBlocks"> - <property name="allowInSwitchCase" value="true" /> - </module> - <module name="ArrayTrailingComma" /> - <module name="AvoidInlineConditionals" /> - <module name="CovariantEquals" /> - <module name="DoubleCheckedLocking" /> - <module name="EmptyStatement" /> - <module name="EqualsHashCode" /> - <module name="FinalLocalVariable" /> - <module name="HiddenField" /> - <module name="IllegalInstantiation"> - <property name="classes" value="java.lang.Boolean" /> - </module> - <module name="IllegalToken"> - <property name="tokens" value="LITERAL_NATIVE" /> - </module> - <module name="InnerAssignment" /> - <module name="MagicNumber" /> - <module name="MissingSwitchDefault" /> - <module name="ModifiedControlVariable" /> - <module name="RedundantThrows" /> - <module name="SimplifyBooleanExpression" /> - <module name="SimplifyBooleanReturn" /> - <module name="StringLiteralEquality" /> - <module name="NestedIfDepth" /> - <module name="NestedTryDepth" /> - <module name="SuperClone" /> - <module name="SuperFinalize" /> - <module name="IllegalCatch" /> - <module name="IllegalThrows" /> - <module name="PackageDeclaration" /> - <module name="JUnitTestCase" /> - <module name="ReturnCount" /> - <module name="IllegalType" /> - <module name="DeclarationOrder" /> - <module name="ParameterAssignment" /> - <module name="ExplicitInitialization" /> - <module name="DefaultComesLast" /> - <module name="MissingCtor" /> - <module name="FallThrough" /> - <module name="MultipleStringLiterals" /> - <module name="MultipleVariableDeclarations" /> - <module name="RequireThis" /> - <module name="UnnecessaryParentheses" /> - <module name="VisibilityModifier" /> - <module name="FinalClass" /> - <module name="InterfaceIsType" /> - <module name="HideUtilityClassConstructor" /> - <module name="DesignForExtension" /> - <module name="MutableException" /> - <!-- <module name="ThrowsCount"/> --> - <module name="BooleanExpressionComplexity" /> - <module name="ClassDataAbstractionCoupling" /> - <module name="ClassFanOutComplexity" /> - <module name="CyclomaticComplexity" /> - <module name="NPathComplexity" /> - <module name="JavaNCSS" /> - <module name="TodoComment" /> - <module name="UncommentedMain" /> - <module name="UpperEll" /> - <module name="ArrayTypeStyle" /> - <module name="FinalParameters" /> - <module name="DescendantToken" /> - <module name="Indentation" /> - <module name="TrailingComment" /> - </module> - <!-- <module name="StrictDuplicateCode"/> --> - <!-- <module name="NewlineAtEndOfFile"/> --> -</module> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> + +<module name="Checker"> + <module name="SuppressionCommentFilter" /> + <module name="PackageHtml" /> + <module name="TreeWalker"> + <module name="FileContentsHolder" /> + <module name="JavadocType"> + <property name="authorFormat" + value="^&lt;a href=&quot;mailto:([0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})&quot;&gt;([a-zA-Z.\s']{1,50})&lt;/a&gt;$" /> + <property name="versionFormat" + value="^((\d)?(\d{1})(\.{1})(\d)?(\d{1})){1,2}$" /> + </module> + <module name="JavadocMethod" /> + <module name="JavadocVariable" /> + <module name="JavadocStyle"> + <property name="checkEmptyJavadoc" value="true" /> + </module> + <module name="AbstractClassName" /> + <module name="ConstantName" /> + <module name="LocalFinalVariableName" /> + <module name="LocalVariableName" /> + <module name="MemberName" /> + <module name="MethodName" /> + <module name="PackageName" /> + <module name="ParameterName" /> + <module name="StaticVariableName" /> + <module name="TypeName" /> + <module name="TypeName"> + <property name="format" value="^I[a-zA-Z0-9]*$" /> + <property name="tokens" value="INTERFACE_DEF" /> + </module> +<!-- + <module name="RegexpHeader"> + <property name="header" + value="^/\*$\n^ \* Copyright \(c\) 2006-2008 TerraNua Limited\.$\n^ \* All rights reserved, worldwide\.$\n^ \*$\n^ \* This software and all information contained herein is the property of$\n^ \* TerraNua Limited\. Any dissemination, disclosure, use, or reproduction$\n^ \* of this material for any reason inconsistent with the express purpose$\n^ \* for which it has been disclosed is strictly forbidden\.$\n^ \*/$\n^$\n^package\n^$\n" /> + <property name="multiLines" value="12,15" /> + </module> +--> + <module name="AvoidStarImport" /> + <module name="IllegalImport" /> + <module name="RedundantImport" /> + <module name="UnusedImports" /> + <module name="ImportOrder"> + <property name="groups" + value="java,junit,javax,org,net,com" /> + <property name="ordered" value="true" /> + <property name="separated" value="true" /> + </module> + <!-- + <module name="ImportControl"> + <property name="file" value="c:/brian/import-control.xml"/> + </module> + --> + <module name="ExecutableStatementCount" /> + <module name="FileLength" /> + <module name="LineLength"> + <property name="max" value="132" /> + </module> + <module name="MethodLength" /> + <module name="AnonInnerLength" /> + <module name="ParameterNumber" /> + <module name="EmptyForInitializerPad"> + <property name="option" value="nospace" /> + </module> + <module name="EmptyForIteratorPad" /> + <module name="MethodParamPad" /> + <module name="NoWhitespaceAfter"> + <!-- Default tokens and additional GENERIC_START --> + <property name="tokens" + value="ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS, TYPECAST, GENERIC_START" /> + </module> + <module name="NoWhitespaceBefore"> + <!-- Default tokens and additional GENERIC_START and GENERIC_END --> + <property name="tokens" + value="SEMI, POST_DEC, POST_INC, GENERIC_START, GENERIC_END" /> + </module> + <module name="WhitespaceAfter"> + <!-- Default tokens and additional GENERIC_END --> + <property name="tokens" + value="COMMA, SEMI, GENERIC_END" /> + </module> + <module name="WhitespaceAround"> + <!-- Default tokens without GENERIC_START and GENERIC_END --> + <property name="tokens" + value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND, WILDCARD_TYPE" /> + </module> + <module name="OperatorWrap" /> + <module name="ParenPad" /> + <module name="TypecastParenPad" /> + <module name="TabCharacter" /> + <module name="ModifierOrder" /> + <module name="RedundantModifier" /> + <module name="EmptyBlock"> + <property name="option" value="stmt" /> + </module> + <module name="LeftCurly"> + <property name="option" value="nl" /> + </module> + <module name="NeedBraces" /> + <module name="RightCurly"> + <property name="option" value="alone" /> + </module> + <module name="AvoidNestedBlocks"> + <property name="allowInSwitchCase" value="true" /> + </module> + <module name="ArrayTrailingComma" /> + <module name="AvoidInlineConditionals" /> + <module name="CovariantEquals" /> + <module name="DoubleCheckedLocking" /> + <module name="EmptyStatement" /> + <module name="EqualsHashCode" /> + <module name="FinalLocalVariable" /> + <module name="HiddenField" /> + <module name="IllegalInstantiation"> + <property name="classes" value="java.lang.Boolean" /> + </module> + <module name="IllegalToken"> + <property name="tokens" value="LITERAL_NATIVE" /> + </module> + <module name="InnerAssignment" /> + <module name="MagicNumber" /> + <module name="MissingSwitchDefault" /> + <module name="ModifiedControlVariable" /> + <module name="RedundantThrows" /> + <module name="SimplifyBooleanExpression" /> + <module name="SimplifyBooleanReturn" /> + <module name="StringLiteralEquality" /> + <module name="NestedIfDepth" /> + <module name="NestedTryDepth" /> + <module name="SuperClone" /> + <module name="SuperFinalize" /> + <module name="IllegalCatch" /> + <module name="IllegalThrows" /> + <module name="PackageDeclaration" /> + <module name="JUnitTestCase" /> + <module name="ReturnCount" /> + <module name="IllegalType" /> + <module name="DeclarationOrder" /> + <module name="ParameterAssignment" /> + <module name="ExplicitInitialization" /> + <module name="DefaultComesLast" /> + <module name="MissingCtor" /> + <module name="FallThrough" /> + <module name="MultipleStringLiterals" /> + <module name="MultipleVariableDeclarations" /> + <module name="RequireThis" /> + <module name="UnnecessaryParentheses" /> + <module name="VisibilityModifier" /> + <module name="FinalClass" /> + <module name="InterfaceIsType" /> + <module name="HideUtilityClassConstructor" /> + <module name="DesignForExtension" /> + <module name="MutableException" /> + <!-- <module name="ThrowsCount"/> --> + <module name="BooleanExpressionComplexity" /> + <module name="ClassDataAbstractionCoupling" /> + <module name="ClassFanOutComplexity" /> + <module name="CyclomaticComplexity" /> + <module name="NPathComplexity" /> + <module name="JavaNCSS" /> + <module name="TodoComment" /> + <module name="UncommentedMain" /> + <module name="UpperEll" /> + <module name="ArrayTypeStyle" /> + <module name="FinalParameters" /> + <module name="DescendantToken" /> + <module name="Indentation" /> + <module name="TrailingComment" /> + </module> + <!-- <module name="StrictDuplicateCode"/> --> + <!-- <module name="NewlineAtEndOfFile"/> --> +</module> diff --git a/mockns-easymock/.classpath b/mockns-easymock/.classpath old mode 100755 new mode 100644 index 425cd16..7c3d14f --- a/mockns-easymock/.classpath +++ b/mockns-easymock/.classpath @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="UTF-8"?> -<classpath> - <classpathentry kind="src" output="target/classes" path="src/main/java"/> - <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> - <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> - <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> - <classpathentry kind="output" path="target/classes"/> -</classpath> +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" output="target/classes" path="src/main/java"/> + <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> + <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> + <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/mockns-easymock/.project b/mockns-easymock/.project old mode 100755 new mode 100644 index c184171..077ba71 --- a/mockns-easymock/.project +++ b/mockns-easymock/.project @@ -1,29 +1,29 @@ -<?xml version="1.0" encoding="UTF-8"?> -<projectDescription> - <name>mockns-easymock</name> - <comment></comment> - <projects> - </projects> - <buildSpec> - <buildCommand> - <name>org.eclipse.wst.common.project.facet.core.builder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.eclipse.jdt.core.javabuilder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.maven.ide.eclipse.maven2Builder</name> - <arguments> - </arguments> - </buildCommand> - </buildSpec> - <natures> - <nature>org.eclipse.jdt.core.javanature</nature> - <nature>org.maven.ide.eclipse.maven2Nature</nature> - <nature>org.eclipse.wst.common.project.facet.core.nature</nature> - </natures> -</projectDescription> +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns-easymock</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/mockns-easymock/.settings/org.eclipse.jdt.core.prefs b/mockns-easymock/.settings/org.eclipse.jdt.core.prefs old mode 100755 new mode 100644 index 6727b3c..097f855 --- a/mockns-easymock/.settings/org.eclipse.jdt.core.prefs +++ b/mockns-easymock/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,5 @@ -#Tue Sep 15 21:35:47 BST 2009 -eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +#Tue Sep 15 21:35:47 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/mockns-easymock/.settings/org.maven.ide.eclipse.prefs b/mockns-easymock/.settings/org.maven.ide.eclipse.prefs old mode 100755 new mode 100644 index 8be9cf7..55f0968 --- a/mockns-easymock/.settings/org.maven.ide.eclipse.prefs +++ b/mockns-easymock/.settings/org.maven.ide.eclipse.prefs @@ -1,9 +1,9 @@ -#Tue Sep 15 21:35:39 BST 2009 -activeProfiles= -eclipse.preferences.version=1 -fullBuildGoals=process-test-resources -includeModules=false -resolveWorkspaceProjects=true -resourceFilterGoals=process-resources resources\:testResources -skipCompilerPlugin=true -version=1 +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/mockns-easymock/pom.xml b/mockns-easymock/pom.xml old mode 100755 new mode 100644 index 27e76c8..d861d80 --- a/mockns-easymock/pom.xml +++ b/mockns-easymock/pom.xml @@ -1,43 +1,43 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://maven.apache.org/POM/4.0.0 - http://maven.apache.org/maven-v4_0_0.xsd"> - <parent> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns</artifactId> - <version>0.1.0-SNAPSHOT</version> - </parent> - <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-easymock</artifactId> - <name>MockNS for EasyMock</name> - <dependencies> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-beans</artifactId> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-context</artifactId> - </dependency> - <dependency> - <groupId>org.easymock</groupId> - <artifactId>easymock</artifactId> - </dependency> - <dependency> - <groupId>org.easymock</groupId> - <artifactId>easymockclassextension</artifactId> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-test</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <scope>test</scope> - </dependency> - </dependencies> +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <version>0.1.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-easymock</artifactId> + <name>MockNS for EasyMock</name> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymock</artifactId> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymockclassextension</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> </project> \ No newline at end of file diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java old mode 100755 new mode 100644 index 6c1199a..490656a --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java @@ -1,80 +1,82 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.easymock; - -import org.springframework.beans.factory.support.BeanDefinitionBuilder; -import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; -import org.w3c.dom.Element; - -/** - * The bean definition parser for the EasyMock mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class MockBeanDefinitionParser - extends AbstractSingleBeanDefinitionParser -{ - /** - * The default constructor. - */ - public MockBeanDefinitionParser() - { - } - - /** - * Parse an XML bean definition. - * - * @param element - * The element that defines the bean. - * @param builder - * Helps build the bean definition. - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) - */ - @Override - protected void doParse(final Element element, final BeanDefinitionBuilder builder) - { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - } - - /** - * Get class of the factory used to create the beans. - * - * @return Always returns {@link MockFactoryBean}. - * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) - */ - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) - { - return MockFactoryBean.class; - } - - /** - * Indicate that the bean factory should generate an identifier for the bean - * if one is not present. - * - * @return Always returns <code>true</code> - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() - */ - @Override - protected boolean shouldGenerateIdAsFallback() - { - return true; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } + + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } + + /** + * Get class of the factory used to create the beans. + * + * @param element + * The element that defines the bean. + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } + + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } +} diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java old mode 100755 new mode 100644 index 6f36ef8..bda8862 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java @@ -1,83 +1,83 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.easymock; - -import org.easymock.classextension.EasyMock; -import org.springframework.beans.factory.FactoryBean; - -/** - * The factory bean that creates EasyMock mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class MockFactoryBean - implements FactoryBean -{ - /** - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - private Class objectClass; - - /** - * The constructor. - * - * @param objectClass - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class objectClass) - { - this.objectClass = objectClass; - } - - /** - * Create the mock object. - * - * @return The mock object. - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() - { - return EasyMock.createMock(this.objectClass); - } - - /** - * Return the interface or class that will be mocked. - * - * @return The interface or class. - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() - { - return this.objectClass; - } - - /** - * Indicate that mock objects created by this factory are singletons. - * - * @return Always returns <code>true</code>. - */ - @Override - public boolean isSingleton() - { - return true; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock; + +import org.easymock.classextension.EasyMock; +import org.springframework.beans.factory.FactoryBean; + +/** + * The factory bean that creates EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockFactoryBean + implements FactoryBean +{ + /** + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + private Class objectClass; + + /** + * The constructor. + * + * @param clazz + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class clazz) + { + this.objectClass = clazz; + } + + /** + * Create the mock object. + * + * @return The mock object. + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() + { + return EasyMock.createMock(this.objectClass); + } + + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() + { + return this.objectClass; + } + + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + */ + @Override + public boolean isSingleton() + { + return true; + } +} diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java old mode 100755 new mode 100644 index dc83cd9..2c9bb50 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java @@ -1,47 +1,47 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.easymock; - -import org.springframework.beans.factory.xml.NamespaceHandlerSupport; - -/** - * The name-space hander for the EasyMock. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class NamespaceHandler - extends NamespaceHandlerSupport -{ - /** - * The default constructor. - */ - public NamespaceHandler() - { - } - - /** - * Register the bean definition parsers for the name-space. - * - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() - { - this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the EasyMock. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } + + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + } +} diff --git a/mockns-easymock/src/main/resources/META-INF/spring.handlers b/mockns-easymock/src/main/resources/META-INF/spring.handlers old mode 100755 new mode 100644 index e59e3ea..b8b59c4 --- a/mockns-easymock/src/main/resources/META-INF/spring.handlers +++ b/mockns-easymock/src/main/resources/META-INF/spring.handlers @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + http\://mockns.btmatthews.com/schema/easymock=com.btmatthews.mockns.easymock.NamespaceHandler \ No newline at end of file diff --git a/mockns-easymock/src/main/resources/META-INF/spring.schemas b/mockns-easymock/src/main/resources/META-INF/spring.schemas old mode 100755 new mode 100644 index 115523c..503b980 --- a/mockns-easymock/src/main/resources/META-INF/spring.schemas +++ b/mockns-easymock/src/main/resources/META-INF/spring.schemas @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + http\://mockns.btmatthews.com/schema/easymock/easymock.xsd=com/btmatthews/mockns/easymock/easymock.xsd \ No newline at end of file diff --git a/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd b/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd old mode 100755 new mode 100644 index f72c4e8..2fc0655 --- a/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd +++ b/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd @@ -1,30 +1,30 @@ -<?xml version="1.0" encoding="UTF-8"?> -<xsd:schema - xmlns="http://mockns.btmatthews.com/schema/easymock" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns:beans="http://www.springframework.org/schema/beans" - targetNamespace="http://mockns.btmatthews.com/schema/easymock" - elementFormDefault="qualified" - attributeFormDefault="unqualified"> - <xsd:import - namespace="http://www.springframework.org/schema/beans" /> - <xsd:element - name="mock"> - <xsd:annotation> - <xsd:documentation><![CDATA[ - Create an EasyMock mock bean. - ]]></xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:complexContent> - <xsd:extension - base="beans:identifiedType"> - <xsd:attribute - name="object-class" - type="xsd:string" - use="required" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - </xsd:element> +<?xml version="1.0" encoding="UTF-8"?> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/easymock" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/easymock" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an EasyMock mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> </xsd:schema> \ No newline at end of file diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java old mode 100755 new mode 100644 index 5408177..81df73c --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java @@ -1,31 +1,31 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.easymock.test; - -/** - * Interface to be mocked during testing. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public interface Dependency -{ - /** - * Operation to be mocked during testing. - */ - void doSomething(); -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock.test; + +/** + * Interface to be mocked during testing. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public interface Dependency +{ + /** + * Operation to be mocked during testing. + */ + void doSomething(); +} diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java old mode 100755 new mode 100644 index d78c4d6..ae828ed --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java @@ -1,49 +1,49 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.easymock.test; - -import org.springframework.beans.factory.annotation.Autowired; - -/** - * Simple service used to test mocks. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class Service -{ - /** - * The mock object is injected. - */ - @Autowired - private Dependency testDependency; - - /** - * The default constructor. - */ - public Service() - { - } - - /** - * Operation to test the mock object invocation. - */ - public void doSomething() - { - this.testDependency.doSomething(); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock.test; + +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Simple service used to test mocks. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class Service +{ + /** + * The mock object is injected. + */ + @Autowired + private Dependency testDependency; + + /** + * The default constructor. + */ + public Service() + { + } + + /** + * Operation to test the mock object invocation. + */ + public void doSomething() + { + this.testDependency.doSomething(); + } +} diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java old mode 100755 new mode 100644 index 5decc5c..96215cc --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java @@ -1,67 +1,67 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.easymock.test; - -import org.easymock.classextension.EasyMock; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; - -/** - * Unit test the Easy Mock implementation for MockNS. - * - * @author <a href="mailto:[email protected]">[email protected]</a> - * @version 0.1.0 - */ -@RunWith(SpringJUnit4ClassRunner.class) -@ContextConfiguration -public class TestMockNamespace -{ - /** - * Used to test the mocked object. - */ - @Autowired - private Service service; - - /** - * The mocked object. - */ - @Autowired - private Dependency dependency; - - /** - * The default constructor. - */ - public TestMockNamespace() - { - } - - /** - * Test the mocked object. - */ - @Test - public void test() - { - this.dependency.doSomething(); - EasyMock.expectLastCall(); - EasyMock.replay(this.dependency); - this.service.doSomething(); - EasyMock.verify(this.dependency); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock.test; + +import org.easymock.classextension.EasyMock; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Unit test the Easy Mock implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public final class TestMockNamespace +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The default constructor. + */ + public TestMockNamespace() + { + } + + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.dependency.doSomething(); + EasyMock.expectLastCall(); + EasyMock.replay(this.dependency); + this.service.doSomething(); + EasyMock.verify(this.dependency); + } +} diff --git a/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml b/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml old mode 100755 new mode 100644 index 59ce1e1..fda0bde --- a/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml +++ b/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml @@ -1,15 +1,15 @@ -<?xml version="1.0" encoding="UTF-8"?> -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:mockns="http://mockns.btmatthews.com/schema/easymock" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans - http://www.springframework.org/schema/beans/spring-beans.xsd - http://mockns.btmatthews.com/schema/easymock - http://mockns.btmatthews.com/schema/easymock/easymock.xsd"> - - <mockns:mock id="dependency" - object-class="com.btmatthews.mockns.easymock.test.Dependency" /> - - <bean id="service" class="com.btmatthews.mockns.easymock.test.Service" /> - +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/easymock" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/easymock + http://mockns.btmatthews.com/schema/easymock/easymock.xsd"> + + <mockns:mock id="dependency" + object-class="com.btmatthews.mockns.easymock.test.Dependency" /> + + <bean id="service" class="com.btmatthews.mockns.easymock.test.Service" /> + </beans> \ No newline at end of file diff --git a/mockns-jmock/.classpath b/mockns-jmock/.classpath old mode 100755 new mode 100644 index 425cd16..7c3d14f --- a/mockns-jmock/.classpath +++ b/mockns-jmock/.classpath @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="UTF-8"?> -<classpath> - <classpathentry kind="src" output="target/classes" path="src/main/java"/> - <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> - <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> - <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> - <classpathentry kind="output" path="target/classes"/> -</classpath> +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" output="target/classes" path="src/main/java"/> + <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> + <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> + <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/mockns-jmock/.project b/mockns-jmock/.project old mode 100755 new mode 100644 index 9d550d4..d3deb76 --- a/mockns-jmock/.project +++ b/mockns-jmock/.project @@ -1,29 +1,29 @@ -<?xml version="1.0" encoding="UTF-8"?> -<projectDescription> - <name>mockns-jmock</name> - <comment></comment> - <projects> - </projects> - <buildSpec> - <buildCommand> - <name>org.eclipse.wst.common.project.facet.core.builder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.eclipse.jdt.core.javabuilder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.maven.ide.eclipse.maven2Builder</name> - <arguments> - </arguments> - </buildCommand> - </buildSpec> - <natures> - <nature>org.eclipse.jdt.core.javanature</nature> - <nature>org.maven.ide.eclipse.maven2Nature</nature> - <nature>org.eclipse.wst.common.project.facet.core.nature</nature> - </natures> -</projectDescription> +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns-jmock</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/mockns-jmock/.settings/org.eclipse.jdt.core.prefs b/mockns-jmock/.settings/org.eclipse.jdt.core.prefs old mode 100755 new mode 100644 index 7ea6233..1eadcad --- a/mockns-jmock/.settings/org.eclipse.jdt.core.prefs +++ b/mockns-jmock/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,5 @@ -#Tue Sep 15 21:35:49 BST 2009 -eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +#Tue Sep 15 21:35:49 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/mockns-jmock/.settings/org.maven.ide.eclipse.prefs b/mockns-jmock/.settings/org.maven.ide.eclipse.prefs old mode 100755 new mode 100644 index 8be9cf7..55f0968 --- a/mockns-jmock/.settings/org.maven.ide.eclipse.prefs +++ b/mockns-jmock/.settings/org.maven.ide.eclipse.prefs @@ -1,9 +1,9 @@ -#Tue Sep 15 21:35:39 BST 2009 -activeProfiles= -eclipse.preferences.version=1 -fullBuildGoals=process-test-resources -includeModules=false -resolveWorkspaceProjects=true -resourceFilterGoals=process-resources resources\:testResources -skipCompilerPlugin=true -version=1 +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/mockns-jmock/pom.xml b/mockns-jmock/pom.xml old mode 100755 new mode 100644 index 487b344..d30ec98 --- a/mockns-jmock/pom.xml +++ b/mockns-jmock/pom.xml @@ -1,39 +1,39 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://maven.apache.org/POM/4.0.0 - http://maven.apache.org/maven-v4_0_0.xsd"> - <parent> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns</artifactId> - <version>0.1.0-SNAPSHOT</version> - </parent> - <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-jmock</artifactId> - <name>MockNS for jMock</name> - <dependencies> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-beans</artifactId> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-context</artifactId> - </dependency> - <dependency> - <groupId>org.jmock</groupId> - <artifactId>jmock</artifactId> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-test</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <scope>test</scope> - </dependency> - </dependencies> +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <version>0.1.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-jmock</artifactId> + <name>MockNS for jMock</name> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + </dependency> + <dependency> + <groupId>org.jmock</groupId> + <artifactId>jmock</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> </project> \ No newline at end of file diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java old mode 100755 new mode 100644 index a0e2c7f..63a53d7 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java @@ -1,90 +1,92 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock; - -import org.springframework.beans.factory.support.BeanDefinitionBuilder; -import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; -import org.w3c.dom.Element; - -/** - * The bean definition parser for the jMock mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class MockBeanDefinitionParser - extends AbstractSingleBeanDefinitionParser -{ - - /** - * The default constructor. - */ - public MockBeanDefinitionParser() - { - } - - /** - * Parse an XML bean definition. - * - * @param element - * The element that defines the bean. - * @param builder - * Helps build the bean definition. - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) - */ - @Override - protected void doParse(final Element element, final BeanDefinitionBuilder builder) - { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - final String mockery = element.getAttribute("mockery"); - if (mockery != null) - { - builder.addConstructorArgReference(mockery); - } - else - { - builder.addConstructorArgReference("mockery"); - } - } - - /** - * Get class of the factory used to create the beans. - * - * @return Always returns {@link MockFactoryBean}. - * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) - */ - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) - { - return MockFactoryBean.class; - } - - /** - * Indicate that the bean factory should generate an identifier for the bean - * if one is not present. - * - * @return Always returns <code>true</code> - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() - */ - @Override - protected boolean shouldGenerateIdAsFallback() - { - return true; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the jMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } + + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + final String mockery = element.getAttribute("mockery"); + if (mockery != null) + { + builder.addConstructorArgReference(mockery); + } + else + { + builder.addConstructorArgReference("mockery"); + } + } + + /** + * Get class of the factory used to create the beans. + * + * @param element + * The element that defines the bean. + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } + + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } +} diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java old mode 100755 new mode 100644 index 173c26d..036fbc5 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java @@ -1,94 +1,94 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock; - -import org.jmock.Mockery; -import org.springframework.beans.factory.FactoryBean; - -/** - * The bean definition parser for the EasyMock mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ - */ -public class MockFactoryBean - implements FactoryBean -{ - /** - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - private Class objectClass; - - /** - * The context for the mocked objects. - */ - private Mockery mockery; - - /** - * The constructor. - * - * @param objectClass - * The interface or class to be mocked. - * @param mockery - * The context for the mocked objects. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class objectClass, final Mockery mockery) - { - this.objectClass = objectClass; - this.mockery = mockery; - } - - /** - * Create the mock object. - * - * @return The mock object. - * @see org.springframework.beans.factory.FactoryBean#getObject() - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() - { - return this.mockery.mock(this.objectClass); - } - - /** - * Return the interface or class that will be mocked. - * - * @return The interface or class. - * @see org.springframework.beans.factory.FactoryBean#getObjectType() - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() - { - return this.objectClass; - } - - /** - * Indicate that mock objects created by this factory are singletons. - * - * @return Always returns <code>true</code>. - * @see org.springframework.beans.factory.FactoryBean#isSingleton() - */ - @Override - public boolean isSingleton() - { - return true; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.jmock.Mockery; +import org.springframework.beans.factory.FactoryBean; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockFactoryBean + implements FactoryBean +{ + /** + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + private Class objectClass; + + /** + * The context for the mocked objects. + */ + private Mockery mockery; + + /** + * The constructor. + * + * @param clazz + * The interface or class to be mocked. + * @param context + * The context for the mocked objects. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class clazz, final Mockery context) + { + this.objectClass = clazz; + this.mockery = context; + } + + /** + * Create the mock object. + * + * @return The mock object. + * @see org.springframework.beans.factory.FactoryBean#getObject() + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() + { + return this.mockery.mock(this.objectClass); + } + + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + * @see org.springframework.beans.factory.FactoryBean#getObjectType() + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() + { + return this.objectClass; + } + + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + * @see org.springframework.beans.factory.FactoryBean#isSingleton() + */ + @Override + public boolean isSingleton() + { + return true; + } +} diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java old mode 100755 new mode 100644 index 469bbbf..cb9bbe3 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java @@ -1,52 +1,53 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock; - -import org.jmock.Mockery; -import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; -import org.w3c.dom.Element; - -/** - * The bean definition parser for the jMock mockery context objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class MockeryBeanDefinitionParser - extends AbstractSingleBeanDefinitionParser -{ - - /** - * The default constructor. - */ - public MockeryBeanDefinitionParser() - { - } - - /** - * Get class of the factory used to create the beans. - * - * @return Always returns {@link MockFactoryBean}. - * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) - */ - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) - { - return Mockery.class; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.jmock.Mockery; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the jMock mockery context objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockeryBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + /** + * The default constructor. + */ + public MockeryBeanDefinitionParser() + { + } + + /** + * Get class of the factory used to create the beans. + * + * @param element + * The element that defines the bean. + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return Mockery.class; + } +} diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java old mode 100755 new mode 100644 index 5cbe986..7f67949 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java @@ -1,49 +1,49 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock; - -import org.springframework.beans.factory.xml.NamespaceHandlerSupport; - -/** - * The name-space hander for the jMock. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ - */ -public class NamespaceHandler - extends NamespaceHandlerSupport -{ - /** - * The default constructor. - */ - public NamespaceHandler() - { - } - - /** - * Register the bean definition parsers for the name-space. - * - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() - { - this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); - this.registerBeanDefinitionParser("mockery", new MockeryBeanDefinitionParser()); - } - -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the jMock. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } + + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + this.registerBeanDefinitionParser("mockery", new MockeryBeanDefinitionParser()); + } + +} diff --git a/mockns-jmock/src/main/resources/META-INF/spring.handlers b/mockns-jmock/src/main/resources/META-INF/spring.handlers old mode 100755 new mode 100644 index fc170ef..9832106 --- a/mockns-jmock/src/main/resources/META-INF/spring.handlers +++ b/mockns-jmock/src/main/resources/META-INF/spring.handlers @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + http\://mockns.btmatthews.com/schema/jmock=com.btmatthews.mockns.jmock.NamespaceHandler \ No newline at end of file diff --git a/mockns-jmock/src/main/resources/META-INF/spring.schemas b/mockns-jmock/src/main/resources/META-INF/spring.schemas old mode 100755 new mode 100644 index 1ec29a0..915469c --- a/mockns-jmock/src/main/resources/META-INF/spring.schemas +++ b/mockns-jmock/src/main/resources/META-INF/spring.schemas @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + http\://mockns.btmatthews.com/schema/jmock/jmock.xsd=com/btmatthews/mockns/jmock/jmock.xsd \ No newline at end of file diff --git a/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd b/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd old mode 100755 new mode 100644 index ea33e37..0bb1da9 --- a/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd +++ b/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd @@ -1,42 +1,42 @@ -<?xml version="1.0" encoding="UTF-8"?> -<xsd:schema - xmlns="http://mockns.btmatthews.com/schema/jmock" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns:beans="http://www.springframework.org/schema/beans" - targetNamespace="http://mockns.btmatthews.com/schema/jmock" - elementFormDefault="qualified" - attributeFormDefault="unqualified"> - <xsd:import - namespace="http://www.springframework.org/schema/beans" /> - <xsd:element - name="mockery"> - <xsd:annotation> - <xsd:documentation><![CDATA[ - Create an jMock mockery. - ]]></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element - name="mock"> - <xsd:annotation> - <xsd:documentation><![CDATA[ - Create an jMock mock bean. - ]]></xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:complexContent> - <xsd:extension - base="beans:identifiedType"> - <xsd:attribute - name="object-class" - type="xsd:string" - use="required" /> - <xsd:attribute - name="mockery" - type="xsd:string" - use="optional" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - </xsd:element> +<?xml version="1.0" encoding="UTF-8"?> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/jmock" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/jmock" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mockery"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an jMock mockery. + ]]></xsd:documentation> + </xsd:annotation> + </xsd:element> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an jMock mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + <xsd:attribute + name="mockery" + type="xsd:string" + use="optional" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> </xsd:schema> \ No newline at end of file diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java old mode 100755 new mode 100644 index 5e5c056..c78e604 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java @@ -1,31 +1,31 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock.test; - -/** - * Interface to be mocked during testing. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public interface Dependency -{ - /** - * Operation to be mocked during testing. - */ - void doSomething(); -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock.test; + +/** + * Interface to be mocked during testing. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public interface Dependency +{ + /** + * Operation to be mocked during testing. + */ + void doSomething(); +} diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java old mode 100755 new mode 100644 index ccf68c8..73791cd --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java @@ -1,49 +1,49 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock.test; - -import org.springframework.beans.factory.annotation.Autowired; - -/** - * Simple service used to test mocks. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class Service -{ - /** - * The mock object is injected. - */ - @Autowired - private Dependency testDependency; - - /** - * The default constructor. - */ - public Service() - { - } - - /** - * Operation to test the mock object invocation. - */ - public void doSomething() - { - this.testDependency.doSomething(); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock.test; + +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Simple service used to test mocks. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class Service +{ + /** + * The mock object is injected. + */ + @Autowired + private Dependency testDependency; + + /** + * The default constructor. + */ + public Service() + { + } + + /** + * Operation to test the mock object invocation. + */ + public void doSomething() + { + this.testDependency.doSomething(); + } +} diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java old mode 100755 new mode 100644 index c849aa8..6a24056 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java @@ -1,77 +1,77 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.jmock.test; - -import org.jmock.Expectations; -import org.jmock.Mockery; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; - -/** - * Unit test the jMock implementation for MockNS. - * - * @author <a href="mailto:[email protected]">[email protected]</a> - * @version 0.1.0 - * - */ -@RunWith(SpringJUnit4ClassRunner.class) -@ContextConfiguration -public class TestMockNamespace -{ - /** - * Used to test the mocked object. - */ - @Autowired - private Service service; - - /** - * The mocked object. - */ - @Autowired - private Dependency dependency; - - /** - * The context for the mocked object. - */ - @Autowired - private Mockery mockery; - - /** - * The default constructor. - */ - public TestMockNamespace() - { - } - - /** - * Test the mocked object. - */ - @Test - public void test() - { - this.mockery.checking(new Expectations() - { - { - allowing(TestMockNamespace.this.dependency).doSomething(); - } - }); - this.service.doSomething(); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock.test; + +import org.jmock.Expectations; +import org.jmock.Mockery; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Unit test the jMock implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + * + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public final class TestMockNamespace +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The context for the mocked object. + */ + @Autowired + private Mockery mockery; + + /** + * The default constructor. + */ + public TestMockNamespace() + { + } + + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.mockery.checking(new Expectations() + { + { + allowing(TestMockNamespace.this.dependency).doSomething(); + } + }); + this.service.doSomething(); + } +} diff --git a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml old mode 100755 new mode 100644 index 59ea59c..afbef5a --- a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml +++ b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml @@ -1,19 +1,19 @@ -<?xml version="1.0" encoding="UTF-8"?> -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:mockns="http://mockns.btmatthews.com/schema/jmock" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans - http://www.springframework.org/schema/beans/spring-beans.xsd - http://mockns.btmatthews.com/schema/jmock - http://mockns.btmatthews.com/schema/jmock/jmock.xsd"> - - <mockns:mockery id="mockery" /> - - <mockns:mock id="dependency" - object-class="com.btmatthews.mockns.jmock.test.Dependency" - mockery="mockery" /> - - <bean id="service" class="com.btmatthews.mockns.jmock.test.Service" /> - +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/jmock" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/jmock + http://mockns.btmatthews.com/schema/jmock/jmock.xsd"> + + <mockns:mockery id="mockery" /> + + <mockns:mock id="dependency" + object-class="com.btmatthews.mockns.jmock.test.Dependency" + mockery="mockery" /> + + <bean id="service" class="com.btmatthews.mockns.jmock.test.Service" /> + </beans> \ No newline at end of file diff --git a/mockns-mockito/.classpath b/mockns-mockito/.classpath old mode 100755 new mode 100644 index 425cd16..7c3d14f --- a/mockns-mockito/.classpath +++ b/mockns-mockito/.classpath @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="UTF-8"?> -<classpath> - <classpathentry kind="src" output="target/classes" path="src/main/java"/> - <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> - <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> - <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> - <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> - <classpathentry kind="output" path="target/classes"/> -</classpath> +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" output="target/classes" path="src/main/java"/> + <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> + <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> + <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/mockns-mockito/.project b/mockns-mockito/.project old mode 100755 new mode 100644 index f300a3f..59f6c8a --- a/mockns-mockito/.project +++ b/mockns-mockito/.project @@ -1,29 +1,29 @@ -<?xml version="1.0" encoding="UTF-8"?> -<projectDescription> - <name>mockns-mockito</name> - <comment></comment> - <projects> - </projects> - <buildSpec> - <buildCommand> - <name>org.eclipse.wst.common.project.facet.core.builder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.eclipse.jdt.core.javabuilder</name> - <arguments> - </arguments> - </buildCommand> - <buildCommand> - <name>org.maven.ide.eclipse.maven2Builder</name> - <arguments> - </arguments> - </buildCommand> - </buildSpec> - <natures> - <nature>org.eclipse.jdt.core.javanature</nature> - <nature>org.maven.ide.eclipse.maven2Nature</nature> - <nature>org.eclipse.wst.common.project.facet.core.nature</nature> - </natures> -</projectDescription> +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns-mockito</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/mockns-mockito/.settings/org.eclipse.jdt.core.prefs b/mockns-mockito/.settings/org.eclipse.jdt.core.prefs old mode 100755 new mode 100644 index b7f0c3a..e6b4341 --- a/mockns-mockito/.settings/org.eclipse.jdt.core.prefs +++ b/mockns-mockito/.settings/org.eclipse.jdt.core.prefs @@ -1,5 +1,5 @@ -#Tue Sep 15 21:35:48 BST 2009 -eclipse.preferences.version=1 -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 -org.eclipse.jdt.core.compiler.compliance=1.6 -org.eclipse.jdt.core.compiler.source=1.6 +#Tue Sep 15 21:35:48 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/mockns-mockito/.settings/org.maven.ide.eclipse.prefs b/mockns-mockito/.settings/org.maven.ide.eclipse.prefs old mode 100755 new mode 100644 index 8be9cf7..55f0968 --- a/mockns-mockito/.settings/org.maven.ide.eclipse.prefs +++ b/mockns-mockito/.settings/org.maven.ide.eclipse.prefs @@ -1,9 +1,9 @@ -#Tue Sep 15 21:35:39 BST 2009 -activeProfiles= -eclipse.preferences.version=1 -fullBuildGoals=process-test-resources -includeModules=false -resolveWorkspaceProjects=true -resourceFilterGoals=process-resources resources\:testResources -skipCompilerPlugin=true -version=1 +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/mockns-mockito/pom.xml b/mockns-mockito/pom.xml old mode 100755 new mode 100644 index bf5c9e7..c0d8260 --- a/mockns-mockito/pom.xml +++ b/mockns-mockito/pom.xml @@ -1,39 +1,39 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://maven.apache.org/POM/4.0.0 - http://maven.apache.org/maven-v4_0_0.xsd"> - <parent> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns</artifactId> - <version>0.1.0-SNAPSHOT</version> - </parent> - <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-mockito</artifactId> - <name>MockNS for Mockito</name> - <dependencies> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-beans</artifactId> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-context</artifactId> - </dependency> - <dependency> - <groupId>org.mockito</groupId> - <artifactId>mockito-core</artifactId> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-test</artifactId> - <scope>test</scope> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <scope>test</scope> - </dependency> - </dependencies> +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <version>0.1.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-mockito</artifactId> + <name>MockNS for Mockito</name> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + </dependency> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> </project> \ No newline at end of file diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java old mode 100755 new mode 100644 index 2715916..3bd7cd9 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java @@ -1,80 +1,82 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito; - -import org.springframework.beans.factory.support.BeanDefinitionBuilder; -import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; -import org.w3c.dom.Element; - -/** - * The bean definition parser for the Mockito mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ - */ -public class MockBeanDefinitionParser - extends AbstractSingleBeanDefinitionParser -{ - /** - * The default constructor. - */ - public MockBeanDefinitionParser() - { - } - - /** - * Parse an XML bean definition. - * - * @param element - * The element that defines the bean. - * @param builder - * Helps build the bean definition. - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) - */ - @Override - protected void doParse(final Element element, final BeanDefinitionBuilder builder) - { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - } - - /** - * Get class of the factory used to create the beans. - * - * @return Always returns {@link MockFactoryBean}. - * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) - */ - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) - { - return MockFactoryBean.class; - } - - /** - * Indicate that the bean factory should generate an identifier for the bean - * if one is not present. - * - * @return Always returns <code>true</code> - * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() - */ - @Override - protected boolean shouldGenerateIdAsFallback() - { - return true; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the Mockito mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } + + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } + + /** + * Get class of the factory used to create the beans. + * + * @param element + * The element that defines the bean. + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } + + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } +} diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java old mode 100755 new mode 100644 index 8d8eea4..9ebcd84 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java @@ -1,86 +1,86 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito; - -import org.mockito.Mockito; -import org.springframework.beans.factory.FactoryBean; - -/** - * The bean definition parser for the EasyMock mock objects. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ - */ -public class MockFactoryBean - implements FactoryBean -{ - /** - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - private Class objectClass; - - /** - * The constructor. - * - * @param objectClass - * The interface or class to be mocked. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class objectClass) - { - this.objectClass = objectClass; - } - - /** - * Create the mock object. - * - * @return The mock object. - * @see org.springframework.beans.factory.FactoryBean#getObject() - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() - { - return Mockito.mock(this.objectClass); - } - - /** - * Return the interface or class that will be mocked. - * - * @return The interface or class. - * @see org.springframework.beans.factory.FactoryBean#getObjectType() - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() - { - return this.objectClass; - } - - /** - * Indicate that mock objects created by this factory are singletons. - * - * @return Always returns <code>true</code>. - * @see org.springframework.beans.factory.FactoryBean#isSingleton() - */ - @Override - public boolean isSingleton() - { - return true; - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.mockito.Mockito; +import org.springframework.beans.factory.FactoryBean; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class MockFactoryBean + implements FactoryBean +{ + /** + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + private Class objectClass; + + /** + * The constructor. + * + * @param clazz + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class clazz) + { + this.objectClass = clazz; + } + + /** + * Create the mock object. + * + * @return The mock object. + * @see org.springframework.beans.factory.FactoryBean#getObject() + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() + { + return Mockito.mock(this.objectClass); + } + + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + * @see org.springframework.beans.factory.FactoryBean#getObjectType() + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() + { + return this.objectClass; + } + + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + * @see org.springframework.beans.factory.FactoryBean#isSingleton() + */ + @Override + public boolean isSingleton() + { + return true; + } +} diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java old mode 100755 new mode 100644 index 78535e3..2aea3b8 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java @@ -1,48 +1,48 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito; - -import org.springframework.beans.factory.xml.NamespaceHandlerSupport; - -/** - * The name-space hander for the Mockito. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ - */ -public class NamespaceHandler - extends NamespaceHandlerSupport -{ - /** - * The default constructor. - */ - public NamespaceHandler() - { - } - - /** - * Register the bean definition parsers for the name-space. - * - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() - { - this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); - } - -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the Mockito. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } + + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + } + +} diff --git a/mockns-mockito/src/main/resources/META-INF/spring.handlers b/mockns-mockito/src/main/resources/META-INF/spring.handlers old mode 100755 new mode 100644 index 8e2c2a3..765c0e3 --- a/mockns-mockito/src/main/resources/META-INF/spring.handlers +++ b/mockns-mockito/src/main/resources/META-INF/spring.handlers @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + http\://mockns.btmatthews.com/schema/mockito=com.btmatthews.mockns.mockito.NamespaceHandler \ No newline at end of file diff --git a/mockns-mockito/src/main/resources/META-INF/spring.schemas b/mockns-mockito/src/main/resources/META-INF/spring.schemas old mode 100755 new mode 100644 index 48e59bf..f8838e8 --- a/mockns-mockito/src/main/resources/META-INF/spring.schemas +++ b/mockns-mockito/src/main/resources/META-INF/spring.schemas @@ -1,15 +1,15 @@ -# Copyright (c) 2009 Brian Thomas Matthews -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + http\://mockns.btmatthews.com/schema/mockito/mockito.xsd=com/btmatthews/mockns/mockito/mockito.xsd \ No newline at end of file diff --git a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd old mode 100755 new mode 100644 index 2a06e98..46f92b0 --- a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd +++ b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd @@ -1,30 +1,30 @@ -<?xml version="1.0" encoding="UTF-8"?> -<xsd:schema - xmlns="http://mockns.btmatthews.com/schema/mockito" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns:beans="http://www.springframework.org/schema/beans" - targetNamespace="http://mockns.btmatthews.com/schema/mockito" - elementFormDefault="qualified" - attributeFormDefault="unqualified"> - <xsd:import - namespace="http://www.springframework.org/schema/beans" /> - <xsd:element - name="mock"> - <xsd:annotation> - <xsd:documentation><![CDATA[ - Create an Mockito mock bean. - ]]></xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:complexContent> - <xsd:extension - base="beans:identifiedType"> - <xsd:attribute - name="object-class" - type="xsd:string" - use="required" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - </xsd:element> +<?xml version="1.0" encoding="UTF-8"?> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/mockito" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/mockito" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an Mockito mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> </xsd:schema> \ No newline at end of file diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java old mode 100755 new mode 100644 index 17ce26c..ebb9b49 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java @@ -1,31 +1,31 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito.test; - -/** - * Interface to be mocked during testing. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public interface Dependency -{ - /** - * Operation to be mocked during testing. - */ - void doSomething(); -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito.test; + +/** + * Interface to be mocked during testing. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public interface Dependency +{ + /** + * Operation to be mocked during testing. + */ + void doSomething(); +} diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java old mode 100755 new mode 100644 index e4c4bf4..ce3e45c --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java @@ -1,49 +1,49 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito.test; - -import org.springframework.beans.factory.annotation.Autowired; - -/** - * Simple service used to test mocks. - * - * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version 0.1.0 - */ -public class Service -{ - /** - * The mock object is injected. - */ - @Autowired - private Dependency testDependency; - - /** - * The default constructor. - */ - public Service() - { - } - - /** - * Operation to test the mock object invocation. - */ - public void doSomething() - { - this.testDependency.doSomething(); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito.test; + +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Simple service used to test mocks. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public final class Service +{ + /**s + * The mock object is injected. + */ + @Autowired + private Dependency testDependency; + + /** + * The default constructor. + */ + public Service() + { + } + + /** + * Operation to test the mock object invocation. + */ + public void doSomething() + { + this.testDependency.doSomething(); + } +} diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java old mode 100755 new mode 100644 index a028329..9fcd6c2 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java @@ -1,64 +1,64 @@ -/* - * Copyright (c) 2009 Brian Thomas Matthews - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.btmatthews.mockns.mockito.test; - -import org.junit.Test; -import org.junit.runner.RunWith; -import org.mockito.Mockito; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; - -/** - * Unit test the Mockito implementation for MockNS. - * - * @author <a href="mailto:[email protected]">[email protected]</a> - * @version 0.1.0 - */ -@RunWith(SpringJUnit4ClassRunner.class) -@ContextConfiguration -public class TestMockNamespace -{ - /** - * Used to test the mocked object. - */ - @Autowired - private Service service; - - /** - * The mocked object. - */ - @Autowired - private Dependency dependency; - - /** - * The default constructor. - */ - public TestMockNamespace() - { - } - - /** - * Test the mocked object. - */ - @Test - public void test() - { - this.service.doSomething(); - Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); - } -} +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito.test; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mockito; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Unit test the Mockito implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public final class TestMockNamespace +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The default constructor. + */ + public TestMockNamespace() + { + } + + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.service.doSomething(); + Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); + } +} diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml old mode 100755 new mode 100644 index ca4be1b..037ed19 --- a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml @@ -1,16 +1,16 @@ -<?xml version="1.0" encoding="UTF-8"?> -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans - http://www.springframework.org/schema/beans/spring-beans.xsd - http://mockns.btmatthews.com/schema/mockito - http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> - - <mockns:mock id="dependency" - object-class="com.btmatthews.mockns.mockito.test.Dependency" /> - - <bean id="service" class="com.btmatthews.mockns.mockito.test.Service" /> - +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/mockito + http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> + + <mockns:mock + object-class="com.btmatthews.mockns.mockito.test.Dependency" /> + + <bean class="com.btmatthews.mockns.mockito.test.Service" /> + </beans> \ No newline at end of file diff --git a/pom.xml b/pom.xml old mode 100755 new mode 100644 index c4aa935..7d539f0 --- a/pom.xml +++ b/pom.xml @@ -1,268 +1,268 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation=" - http://maven.apache.org/POM/4.0.0 - http://maven.apache.org/maven-v4_0_0.xsd"> - <modelVersion>4.0.0</modelVersion> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns</artifactId> - <packaging>pom</packaging> - <name>MockNS</name> - <version>0.1.0-SNAPSHOT</version> - <modules> - <module>mockns-easymock</module> - <module>mockns-jmock</module> - <module>mockns-mockito</module> - </modules> - <description></description> - <url>http://mockns.btmatthews.com</url> - <inceptionYear>2009</inceptionYear> - <licenses> - <license> - <name>Apache 2</name> - <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> - <distribution>repo</distribution> - </license> - </licenses> - <reporting> - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>findbugs-maven-plugin</artifactId> - <version>2.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-checkstyle-plugin</artifactId> - <version>2.3</version> - <configuration> - <configLocation>../checkstyle.xml</configLocation> - <encoding>UTF-8</encoding> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-pmd-plugin</artifactId> - <version>2.4</version> - <configuration> - <aggregate>true</aggregate> - <linkXRef>true</linkXRef> - <sourceEncoding>UTF-8</sourceEncoding> - <targetJdk>1.6</targetJdk> - </configuration> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>taglist-maven-plugin</artifactId> - <version>2.3</version> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>jdepend-maven-plugin</artifactId> - <version>2.0-beta-2</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-surefire-report-plugin</artifactId> - <version>2.4.3</version> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>cobertura-maven-plugin</artifactId> - <version>2.3</version> - <configuration> - <quiet>true</quiet> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jxr-plugin</artifactId> - <version>2.1</version> - <configuration> - <aggregate>true</aggregate> - <outputEncoding>UTF-8</outputEncoding> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>2.5</version> - <configuration> - <executions> - <execution> - <goals> - <goal>aggregate</goal> - <goal>test-aggregate</goal> - </goals> - <configuration> - <encoding>UTF-8</encoding> - </configuration> - </execution> - </executions> - </configuration> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>dashboard-maven-plugin</artifactId> - <version>1.0.0-beta-1</version> - </plugin> - </plugins> - </reporting> - <organization> - <name>Brian Thomas Matthews</name> - <url>http://btmatthews.com</url> - </organization> - <issueManagement> - <system>Trac</system> - <url>https://trac.btmatthews.com/projects/mockns</url> - </issueManagement> - <ciManagement> - <system>Continuum</system> - <url>https://continuum.btmatthews.com</url> - </ciManagement> - <developers> - <developer> - <id>bmatthews68</id> - <name>Brian Matthews</name> - <email>[email protected]</email> - <url>http://brian.btmatthews.com</url> - <organization>btmatthews.com</organization> - <organizationUrl>http://btmatthews.com</organizationUrl> - <roles> - <role>developer</role> - </roles> - <timezone>0</timezone> - </developer> - </developers> - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-plugin-plugin</artifactId> - <version>2.5</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-clean-plugin</artifactId> - <version>2.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-resources-plugin</artifactId> - <version>2.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <version>2.2</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-war-plugin</artifactId> - <version>2.1-beta-1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-dependency-plugin</artifactId> - <version>2.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-deploy-plugin</artifactId> - <version>2.4</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-install-plugin</artifactId> - <version>2.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-site-plugin</artifactId> - <version>2.0.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <version>2.0.2</version> - <configuration> - <source>1.6</source> - <target>1.6</target> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-surefire-plugin</artifactId> - <version>2.4.3</version> - </plugin> - </plugins> - </pluginManagement> - </build> - <dependencyManagement> - <dependencies> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-beans</artifactId> - <version>2.5.6</version> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-context</artifactId> - <version>2.5.6</version> - </dependency> - <dependency> - <groupId>org.springframework</groupId> - <artifactId>spring-test</artifactId> - <version>2.5.6</version> - </dependency> - <dependency> - <groupId>org.easymock</groupId> - <artifactId>easymock</artifactId> - <version>2.5.2</version> - </dependency> - <dependency> - <groupId>org.easymock</groupId> - <artifactId>easymockclassextension</artifactId> - <version>2.4</version> - </dependency> - <dependency> - <groupId>org.jmock</groupId> - <artifactId>jmock</artifactId> - <version>2.5.1</version> - </dependency> - <dependency> - <groupId>org.mockito</groupId> - <artifactId>mockito-core</artifactId> - <version>1.8.0</version> - </dependency> +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <packaging>pom</packaging> + <name>MockNS</name> + <version>0.1.0-SNAPSHOT</version> + <modules> + <module>mockns-easymock</module> + <module>mockns-jmock</module> + <module>mockns-mockito</module> + </modules> + <description></description> + <url>http://mockns.btmatthews.com</url> + <inceptionYear>2009</inceptionYear> + <licenses> + <license> + <name>Apache 2</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + </license> + </licenses> + <reporting> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <version>2.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> + <configuration> + <configLocation>../checkstyle.xml</configLocation> + <encoding>UTF-8</encoding> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-pmd-plugin</artifactId> + <version>2.4</version> + <configuration> + <aggregate>true</aggregate> + <linkXRef>true</linkXRef> + <sourceEncoding>UTF-8</sourceEncoding> + <targetJdk>1.6</targetJdk> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>taglist-maven-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>jdepend-maven-plugin</artifactId> + <version>2.0-beta-2</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-report-plugin</artifactId> + <version>2.4.3</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>cobertura-maven-plugin</artifactId> + <version>2.3</version> + <configuration> + <quiet>true</quiet> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jxr-plugin</artifactId> + <version>2.1</version> + <configuration> + <aggregate>true</aggregate> + <outputEncoding>UTF-8</outputEncoding> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.5</version> + <configuration> + <executions> + <execution> + <goals> + <goal>aggregate</goal> + <goal>test-aggregate</goal> + </goals> + <configuration> + <encoding>UTF-8</encoding> + </configuration> + </execution> + </executions> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>dashboard-maven-plugin</artifactId> + <version>1.0.0-beta-1</version> + </plugin> + </plugins> + </reporting> + <organization> + <name>Brian Thomas Matthews</name> + <url>http://btmatthews.com</url> + </organization> + <issueManagement> + <system>Trac</system> + <url>https://trac.btmatthews.com/projects/mockns</url> + </issueManagement> + <ciManagement> + <system>Continuum</system> + <url>https://continuum.btmatthews.com</url> + </ciManagement> + <developers> + <developer> + <id>bmatthews68</id> + <name>Brian Matthews</name> + <email>[email protected]</email> + <url>http://brian.btmatthews.com</url> + <organization>btmatthews.com</organization> + <organizationUrl>http://btmatthews.com</organizationUrl> + <roles> + <role>developer</role> + </roles> + <timezone>0</timezone> + </developer> + </developers> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-plugin-plugin</artifactId> + <version>2.5</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-resources-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <version>2.2</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-war-plugin</artifactId> + <version>2.1-beta-1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <version>2.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-deploy-plugin</artifactId> + <version>2.4</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-install-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>2.0.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <version>2.0.2</version> + <configuration> + <source>1.6</source> + <target>1.6</target> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <version>2.4.3</version> + </plugin> + </plugins> + </pluginManagement> + </build> + <dependencyManagement> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + <version>2.5.6</version> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + <version>2.5.6</version> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <version>2.5.6</version> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymock</artifactId> + <version>2.5.2</version> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymockclassextension</artifactId> + <version>2.4</version> + </dependency> + <dependency> + <groupId>org.jmock</groupId> + <artifactId>jmock</artifactId> + <version>2.5.1</version> + </dependency> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + <version>1.8.0</version> + </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.4</version> - </dependency> - </dependencies> - </dependencyManagement> - <distributionManagement> - <site> - <id>btmatthews.com</id> - <name>MockNS Site</name> - <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> - </site> - <repository> - <id>btmatthews.com</id> - <name>Release Repository</name> - <url>scp://btmatthews.com/var/www/repository.btmatthews.com</url> - </repository> - <snapshotRepository> - <id>btmatthews.com</id> - <name>Snapshot Repository</name> - <url>scp://btmatthews.com/var/www/snapshot.btmatthews.com</url> - </snapshotRepository> - </distributionManagement> - <scm> - <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> - <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> - <url>http://github.com/bmatthews68/MockNS</url> - </scm> + </dependency> + </dependencies> + </dependencyManagement> + <distributionManagement> + <site> + <id>btmatthews.com</id> + <name>MockNS Site</name> + <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> + </site> + <repository> + <id>btmatthews.com</id> + <name>Release Repository</name> + <url>scp://btmatthews.com/var/www/repository.btmatthews.com</url> + </repository> + <snapshotRepository> + <id>btmatthews.com</id> + <name>Snapshot Repository</name> + <url>scp://btmatthews.com/var/www/snapshot.btmatthews.com</url> + </snapshotRepository> + </distributionManagement> + <scm> + <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> + <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> + <url>http://github.com/bmatthews68/MockNS</url> + </scm> </project> \ No newline at end of file diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt old mode 100755 new mode 100644 index b52a919..56311ea --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt @@ -1,57 +1,54 @@ - ------ - Introduction - ------ - Brian Matthews - ------ - 2009-09-25 - ------ - -~~ Copyright (c) 2009 Brian Thomas Matthews -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - - -MockNS - - MockNS provides {{{http://www.springframework.org}Spring}} name-space support for - creating mock objects using EasyMock, jMock or Mockito. - -* MockNS for EasyMock - -------------------- -<dependency> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-easymock</artifactId> - <version>0.1.0-SNAPSHOT</version> -</dependency> -------------------- - -* MockNS for jMock - -------------------- -<dependency> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-jmock</artifactId> - <version>0.1.0-SNAPSHOT</version> -</dependency> -------------------- - -* MockNS for Mockito - -------------------- -<dependency> - <groupId>com.btmatthews.mockns</groupId> - <artifactId>mockns-mockito</artifactId> - <version>0.1.0-SNAPSHOT</version> -</dependency> -------------------- + ------ + Introduction + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +MockNS + + MockNS provides {{{http://www.springframework.org}Spring}} name-space support for + creating mock objects using following frameworks: + + * EasyMock + * jMock + * Mockito. + +* MockNS for EasyMock + + +* MockNS for jMock + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-jmock</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- + +* MockNS for Mockito + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-mockito</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt old mode 100755 new mode 100644 index 76bc1bf..456b6a0 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -1,25 +1,25 @@ - ------ - Usage - ------ - Brian Matthews - ------ - 2009-09-25 - ------ - -~~ Copyright (c) 2009 Brian Thomas Matthews -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - - -Usage - + ------ + Usage + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +Usage + diff --git a/src/site/site.xml b/src/site/site.xml old mode 100755 new mode 100644 index 8873f49..1b03d57 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -1,43 +1,43 @@ -<?xml version="1.0" encoding="ISO-8859-1" ?> -<!-- - Copyright (c) 2009 Brian Thomas Matthews - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<project name="${project.name}"> - <bannerLeft> - <name>MockNS</name> - <href>http://mockns.btmatthews.com</href> - </bannerLeft> - <publishDate format="dd MMM yyyy" position="left" /> - <version position="left" /> - <body> - <links> - <item name="Spring" href="http://www.springframework.org/" /> - <item name="EasyMock" href="http://easymock.org/" /> - <item name="jMock" href="http://www.jmock.org/" /> - <item name="Mockito" href="http://mockito.org/" /> - <item name="Maven 2" href="http://maven.apache.org/" /> - <item name="GitHub" href="http://github.com/" /> - </links> - <menu name="Overview"> - <item name="Introduction" href="index.html" /> - <item name="Usage" href="usage.html" /> - </menu> - <menu ref="modules" /> - <menu ref="reports" /> - </body> - <poweredBy> - <logo name="Maven" href="http://maven.apache.org/" img="http://maven.apache.org/images/logos/maven-feather.png"/> - </poweredBy> +<?xml version="1.0" encoding="ISO-8859-1" ?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project name="${project.name}"> + <bannerLeft> + <name>MockNS</name> + <href>http://mockns.btmatthews.com</href> + </bannerLeft> + <publishDate format="dd MMM yyyy" position="left" /> + <version position="left" /> + <body> + <links> + <item name="Spring" href="http://www.springframework.org/" /> + <item name="EasyMock" href="http://easymock.org/" /> + <item name="jMock" href="http://www.jmock.org/" /> + <item name="Mockito" href="http://mockito.org/" /> + <item name="Maven 2" href="http://maven.apache.org/" /> + <item name="GitHub" href="http://github.com/" /> + </links> + <menu name="Overview"> + <item name="Introduction" href="index.html" /> + <item name="Usage" href="usage.html" /> + </menu> + <menu ref="modules" /> + <menu ref="reports" /> + </body> + <poweredBy> + <logo name="Maven" href="http://maven.apache.org/" img="http://maven.apache.org/images/logos/maven-feather.png"/> + </poweredBy> </project> \ No newline at end of file
bmatthews68/MockNS
eae6fb8f946b6bb7e2cf4fb9d9b4e862e07e7ef7
Added custom site descriptor
diff --git a/pom.xml b/pom.xml index bcb9ea6..c4aa935 100755 --- a/pom.xml +++ b/pom.xml @@ -1,268 +1,268 @@ <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <packaging>pom</packaging> <name>MockNS</name> <version>0.1.0-SNAPSHOT</version> <modules> <module>mockns-easymock</module> <module>mockns-jmock</module> <module>mockns-mockito</module> </modules> <description></description> <url>http://mockns.btmatthews.com</url> <inceptionYear>2009</inceptionYear> <licenses> <license> <name>Apache 2</name> <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> <distribution>repo</distribution> </license> </licenses> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.3</version> <configuration> <configLocation>../checkstyle.xml</configLocation> <encoding>UTF-8</encoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> <version>2.4</version> <configuration> <aggregate>true</aggregate> <linkXRef>true</linkXRef> <sourceEncoding>UTF-8</sourceEncoding> <targetJdk>1.6</targetJdk> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>taglist-maven-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jdepend-maven-plugin</artifactId> <version>2.0-beta-2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>2.4.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.3</version> <configuration> <quiet>true</quiet> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jxr-plugin</artifactId> <version>2.1</version> <configuration> <aggregate>true</aggregate> <outputEncoding>UTF-8</outputEncoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.5</version> <configuration> <executions> <execution> <goals> <goal>aggregate</goal> <goal>test-aggregate</goal> </goals> <configuration> <encoding>UTF-8</encoding> </configuration> </execution> </executions> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>dashboard-maven-plugin</artifactId> <version>1.0.0-beta-1</version> </plugin> </plugins> </reporting> <organization> <name>Brian Thomas Matthews</name> <url>http://btmatthews.com</url> </organization> <issueManagement> <system>Trac</system> <url>https://trac.btmatthews.com/projects/mockns</url> </issueManagement> <ciManagement> <system>Continuum</system> <url>https://continuum.btmatthews.com</url> </ciManagement> <developers> <developer> <id>bmatthews68</id> <name>Brian Matthews</name> <email>[email protected]</email> <url>http://brian.btmatthews.com</url> <organization>btmatthews.com</organization> <organizationUrl>http://btmatthews.com</organizationUrl> <roles> <role>developer</role> </roles> <timezone>0</timezone> </developer> </developers> <build> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-plugin-plugin</artifactId> <version>2.5</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-clean-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.1-beta-1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-deploy-plugin</artifactId> <version>2.4</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>2.0.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>2.0.2</version> <configuration> <source>1.6</source> <target>1.6</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.4.3</version> </plugin> </plugins> </pluginManagement> </build> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> <version>2.5.2</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> <version>2.4</version> </dependency> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> <version>2.5.1</version> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> <version>1.8.0</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.4</version> </dependency> </dependencies> </dependencyManagement> <distributionManagement> <site> - <id>mockns.btmatthews.com</id> + <id>btmatthews.com</id> <name>MockNS Site</name> <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> </site> <repository> - <id>repository.btmatthews.com</id> + <id>btmatthews.com</id> <name>Release Repository</name> <url>scp://btmatthews.com/var/www/repository.btmatthews.com</url> </repository> <snapshotRepository> - <id>snapshot.btmatthews.com</id> + <id>btmatthews.com</id> <name>Snapshot Repository</name> <url>scp://btmatthews.com/var/www/snapshot.btmatthews.com</url> </snapshotRepository> </distributionManagement> <scm> <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> <url>http://github.com/bmatthews68/MockNS</url> </scm> </project> \ No newline at end of file diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt new file mode 100755 index 0000000..b52a919 --- /dev/null +++ b/src/site/apt/index.apt @@ -0,0 +1,57 @@ + ------ + Introduction + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +MockNS + + MockNS provides {{{http://www.springframework.org}Spring}} name-space support for + creating mock objects using EasyMock, jMock or Mockito. + +* MockNS for EasyMock + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-easymock</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- + +* MockNS for jMock + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-jmock</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- + +* MockNS for Mockito + +------------------- +<dependency> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-mockito</artifactId> + <version>0.1.0-SNAPSHOT</version> +</dependency> +------------------- diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt new file mode 100755 index 0000000..76bc1bf --- /dev/null +++ b/src/site/apt/usage.apt @@ -0,0 +1,25 @@ + ------ + Usage + ------ + Brian Matthews + ------ + 2009-09-25 + ------ + +~~ Copyright (c) 2009 Brian Thomas Matthews +~~ +~~ Licensed under the Apache License, Version 2.0 (the "License"); +~~ you may not use this file except in compliance with the License. +~~ You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + + +Usage + diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100755 index 0000000..8873f49 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="ISO-8859-1" ?> +<!-- + Copyright (c) 2009 Brian Thomas Matthews + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project name="${project.name}"> + <bannerLeft> + <name>MockNS</name> + <href>http://mockns.btmatthews.com</href> + </bannerLeft> + <publishDate format="dd MMM yyyy" position="left" /> + <version position="left" /> + <body> + <links> + <item name="Spring" href="http://www.springframework.org/" /> + <item name="EasyMock" href="http://easymock.org/" /> + <item name="jMock" href="http://www.jmock.org/" /> + <item name="Mockito" href="http://mockito.org/" /> + <item name="Maven 2" href="http://maven.apache.org/" /> + <item name="GitHub" href="http://github.com/" /> + </links> + <menu name="Overview"> + <item name="Introduction" href="index.html" /> + <item name="Usage" href="usage.html" /> + </menu> + <menu ref="modules" /> + <menu ref="reports" /> + </body> + <poweredBy> + <logo name="Maven" href="http://maven.apache.org/" img="http://maven.apache.org/images/logos/maven-feather.png"/> + </poweredBy> +</project> \ No newline at end of file
bmatthews68/MockNS
68fda591a319f875428fc4e8f5ea7a4c2f187868
Added SCM and Distribution details
diff --git a/pom.xml b/pom.xml index 2918bc5..bcb9ea6 100755 --- a/pom.xml +++ b/pom.xml @@ -1,258 +1,268 @@ <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <packaging>pom</packaging> <name>MockNS</name> <version>0.1.0-SNAPSHOT</version> <modules> <module>mockns-easymock</module> <module>mockns-jmock</module> <module>mockns-mockito</module> </modules> <description></description> <url>http://mockns.btmatthews.com</url> <inceptionYear>2009</inceptionYear> <licenses> <license> <name>Apache 2</name> <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> <distribution>repo</distribution> </license> </licenses> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.3</version> <configuration> <configLocation>../checkstyle.xml</configLocation> <encoding>UTF-8</encoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> <version>2.4</version> <configuration> <aggregate>true</aggregate> <linkXRef>true</linkXRef> <sourceEncoding>UTF-8</sourceEncoding> <targetJdk>1.6</targetJdk> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>taglist-maven-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jdepend-maven-plugin</artifactId> <version>2.0-beta-2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>2.4.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.3</version> <configuration> <quiet>true</quiet> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jxr-plugin</artifactId> <version>2.1</version> <configuration> <aggregate>true</aggregate> <outputEncoding>UTF-8</outputEncoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.5</version> <configuration> <executions> <execution> <goals> <goal>aggregate</goal> <goal>test-aggregate</goal> </goals> <configuration> <encoding>UTF-8</encoding> </configuration> </execution> </executions> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>dashboard-maven-plugin</artifactId> <version>1.0.0-beta-1</version> </plugin> </plugins> </reporting> <organization> <name>Brian Thomas Matthews</name> <url>http://btmatthews.com</url> </organization> <issueManagement> <system>Trac</system> <url>https://trac.btmatthews.com/projects/mockns</url> </issueManagement> <ciManagement> <system>Continuum</system> <url>https://continuum.btmatthews.com</url> </ciManagement> <developers> <developer> <id>bmatthews68</id> <name>Brian Matthews</name> <email>[email protected]</email> <url>http://brian.btmatthews.com</url> <organization>btmatthews.com</organization> <organizationUrl>http://btmatthews.com</organizationUrl> <roles> <role>developer</role> </roles> <timezone>0</timezone> </developer> </developers> <build> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-plugin-plugin</artifactId> <version>2.5</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-clean-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.1-beta-1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-deploy-plugin</artifactId> <version>2.4</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>2.0.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>2.0.2</version> <configuration> <source>1.6</source> <target>1.6</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.4.3</version> </plugin> </plugins> </pluginManagement> </build> <dependencyManagement> <dependencies> - <!-- Spring --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>2.5.6</version> </dependency> - <!-- EasyMock --> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> <version>2.5.2</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> <version>2.4</version> </dependency> - <!-- jMock --> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> <version>2.5.1</version> </dependency> - <!-- Mockito --> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> <version>1.8.0</version> </dependency> - <!-- JUnit --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.4</version> </dependency> </dependencies> </dependencyManagement> <distributionManagement> <site> <id>mockns.btmatthews.com</id> <name>MockNS Site</name> <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> </site> + <repository> + <id>repository.btmatthews.com</id> + <name>Release Repository</name> + <url>scp://btmatthews.com/var/www/repository.btmatthews.com</url> + </repository> + <snapshotRepository> + <id>snapshot.btmatthews.com</id> + <name>Snapshot Repository</name> + <url>scp://btmatthews.com/var/www/snapshot.btmatthews.com</url> + </snapshotRepository> </distributionManagement> + <scm> + <connection>scm:git:git://github.com/bmatthews68/MockNS.git</connection> + <developerConnection>scm:git:git://github.com/bmatthews68/MockNS.git</developerConnection> + <url>http://github.com/bmatthews68/MockNS</url> + </scm> </project> \ No newline at end of file
bmatthews68/MockNS
d7f5c6bb072845a4d7ea3e4c9e8f73688001f4c6
General tidy up
diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java index 494d1d1..6c1199a 100755 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java @@ -1,65 +1,80 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** * The bean definition parser for the EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ + * @version 0.1.0 */ -public class MockBeanDefinitionParser extends - AbstractSingleBeanDefinitionParser { +public class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } - /** - * The default constructor. - */ - public MockBeanDefinitionParser() { - } + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } - /** - * @param element - * @param builder - */ - @Override - protected void doParse(final Element element, - final BeanDefinitionBuilder builder) { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - final String mockery = element.getAttribute("mockery"); - if (mockery != null) { - builder.addConstructorArgReference(mockery); - } else { - builder.addConstructorArgReference("mockery"); - } - } + /** + * Get class of the factory used to create the beans. + * + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) { - return MockFactoryBean.class; - } - - @Override - protected boolean shouldGenerateIdAsFallback() { - return true; - } + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } } diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java index 761b6b3..6f36ef8 100755 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java @@ -1,67 +1,83 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock; import org.easymock.classextension.EasyMock; import org.springframework.beans.factory.FactoryBean; /** - * The bean definition parser for the EasyMock mock objects. + * The factory bean that creates EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ + * @version 0.1.0 */ -public class MockFactoryBean implements FactoryBean { +public class MockFactoryBean + implements FactoryBean +{ + /** + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + private Class objectClass; - @SuppressWarnings("unchecked") - private Class objectClass; + /** + * The constructor. + * + * @param objectClass + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class objectClass) + { + this.objectClass = objectClass; + } - /** - * The default constructor. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class objectClass) { - this.objectClass = objectClass; - } + /** + * Create the mock object. + * + * @return The mock object. + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() + { + return EasyMock.createMock(this.objectClass); + } - /** - * @return - * @throws Exception - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() throws Exception { - return EasyMock.createMock(this.objectClass); - } + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() + { + return this.objectClass; + } - /** - * @return - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() { - return this.objectClass; - } - - /** - * @return Always returns <code>false</code>. - */ - @Override - public boolean isSingleton() { - return true; - } + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + */ + @Override + public boolean isSingleton() + { + return true; + } } diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java index 188c79d..dc83cd9 100755 --- a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java @@ -1,38 +1,47 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.easymock; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** * The name-space hander for the EasyMock. * * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ + * @version 0.1.0 */ -public class NamespaceHandler extends NamespaceHandlerSupport { - - /** - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() { - this.registerBeanDefinitionParser("mock", - new MockBeanDefinitionParser()); - } +public class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + } } diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java index 9aba127..5408177 100755 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java @@ -1,6 +1,31 @@ -package com.btmatthews.mockns.easymock.test; +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ -public interface Dependency { +package com.btmatthews.mockns.easymock.test; - void doSomething(); +/** + * Interface to be mocked during testing. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public interface Dependency +{ + /** + * Operation to be mocked during testing. + */ + void doSomething(); } diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java index 27774d5..d78c4d6 100755 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java @@ -1,13 +1,49 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.btmatthews.mockns.easymock.test; import org.springframework.beans.factory.annotation.Autowired; -public class Service { +/** + * Simple service used to test mocks. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public class Service +{ + /** + * The mock object is injected. + */ + @Autowired + private Dependency testDependency; + + /** + * The default constructor. + */ + public Service() + { + } - @Autowired - private Dependency testDependency; - - public void doSomething() { - this.testDependency.doSomething(); - } + /** + * Operation to test the mock object invocation. + */ + public void doSomething() + { + this.testDependency.doSomething(); + } } diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java index 00f593b..5decc5c 100755 --- a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java @@ -1,27 +1,67 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.btmatthews.mockns.easymock.test; import org.easymock.classextension.EasyMock; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +/** + * Unit test the Easy Mock implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration -public class TestMockNamespace { - @Autowired - private Service service; +public class TestMockNamespace +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The default constructor. + */ + public TestMockNamespace() + { + } - @Autowired - private Dependency dependency; - - @Test - public void test() { - this.dependency.doSomething(); - EasyMock.expectLastCall(); - EasyMock.replay(this.dependency); - this.service.doSomething(); - EasyMock.verify(this.dependency); - } + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.dependency.doSomething(); + EasyMock.expectLastCall(); + EasyMock.replay(this.dependency); + this.service.doSomething(); + EasyMock.verify(this.dependency); + } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java index 058d119..a0e2c7f 100755 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java @@ -1,59 +1,90 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** - * The bean definition parser for the EasyMock mock objects. + * The bean definition parser for the jMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ + * @version 0.1.0 */ -public class MockBeanDefinitionParser extends - AbstractSingleBeanDefinitionParser { +public class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ - /** - * The default constructor. - */ - public MockBeanDefinitionParser() { - } + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } - /** - * @param element - * @param builder - */ - @Override - protected void doParse(final Element element, - final BeanDefinitionBuilder builder) { - final String objectClass = element.getAttribute("object-class"); - builder.addConstructorArgValue(objectClass); - } + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + final String mockery = element.getAttribute("mockery"); + if (mockery != null) + { + builder.addConstructorArgReference(mockery); + } + else + { + builder.addConstructorArgReference("mockery"); + } + } - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) { - return MockFactoryBean.class; - } + /** + * Get class of the factory used to create the beans. + * + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } - @Override - protected boolean shouldGenerateIdAsFallback() { - return true; - } + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java index 9c536ae..173c26d 100755 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java @@ -1,70 +1,94 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.jmock.Mockery; import org.springframework.beans.factory.FactoryBean; /** * The bean definition parser for the EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version $Rev$ */ -public class MockFactoryBean implements FactoryBean { +public class MockFactoryBean + implements FactoryBean +{ + /** + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + private Class objectClass; - @SuppressWarnings("unchecked") - private Class objectClass; + /** + * The context for the mocked objects. + */ + private Mockery mockery; - private Mockery mockery; + /** + * The constructor. + * + * @param objectClass + * The interface or class to be mocked. + * @param mockery + * The context for the mocked objects. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class objectClass, final Mockery mockery) + { + this.objectClass = objectClass; + this.mockery = mockery; + } - /** - * The default constructor. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class objectClass, final Mockery mockery) { - this.objectClass = objectClass; - this.mockery = mockery; - } + /** + * Create the mock object. + * + * @return The mock object. + * @see org.springframework.beans.factory.FactoryBean#getObject() + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() + { + return this.mockery.mock(this.objectClass); + } - /** - * @return - * @throws Exception - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() throws Exception { - return this.mockery.mock(this.objectClass); - } + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + * @see org.springframework.beans.factory.FactoryBean#getObjectType() + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() + { + return this.objectClass; + } - /** - * @return - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() { - return this.objectClass; - } - - /** - * @return Always returns <code>false</code>. - */ - @Override - public boolean isSingleton() { - return true; - } + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + * @see org.springframework.beans.factory.FactoryBean#isSingleton() + */ + @Override + public boolean isSingleton() + { + return true; + } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java index bc6ef0e..469bbbf 100755 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java @@ -1,53 +1,52 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.jmock.Mockery; -import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** - * The bean definition parser for the EasyMock mock objects. + * The bean definition parser for the jMock mockery context objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> - * @version $Rev$ + * @version 0.1.0 */ -public class MockeryBeanDefinitionParser extends - AbstractSingleBeanDefinitionParser { +public class MockeryBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ - /** - * The default constructor. - */ - public MockeryBeanDefinitionParser() { - } + /** + * The default constructor. + */ + public MockeryBeanDefinitionParser() + { + } - /** - * @param element - * @param builder - */ - @Override - protected void doParse(final Element element, - final BeanDefinitionBuilder builder) { - } - - @SuppressWarnings("unchecked") - @Override - protected Class getBeanClass(final Element element) { - return Mockery.class; - } + /** + * Get class of the factory used to create the beans. + * + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) + { + return Mockery.class; + } } diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java index 89f9a1c..5cbe986 100755 --- a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java @@ -1,40 +1,49 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.jmock; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** - * The name-space hander for the EasyMock. + * The name-space hander for the jMock. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version $Rev$ */ -public class NamespaceHandler extends NamespaceHandlerSupport { +public class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } - /** - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() { - this.registerBeanDefinitionParser("mock", - new MockBeanDefinitionParser()); - this.registerBeanDefinitionParser("mockery", - new MockeryBeanDefinitionParser()); - } + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + this.registerBeanDefinitionParser("mockery", new MockeryBeanDefinitionParser()); + } } diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java index 14792da..5e5c056 100755 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java @@ -1,6 +1,31 @@ -package com.btmatthews.mockns.jmock.test; +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ -public interface Dependency { +package com.btmatthews.mockns.jmock.test; - void doSomething(); +/** + * Interface to be mocked during testing. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public interface Dependency +{ + /** + * Operation to be mocked during testing. + */ + void doSomething(); } diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java index 12b9619..ccf68c8 100755 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java @@ -1,13 +1,49 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.btmatthews.mockns.jmock.test; import org.springframework.beans.factory.annotation.Autowired; -public class Service { +/** + * Simple service used to test mocks. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public class Service +{ + /** + * The mock object is injected. + */ + @Autowired + private Dependency testDependency; + + /** + * The default constructor. + */ + public Service() + { + } - @Autowired - private Dependency testDependency; - - public void doSomething() { - this.testDependency.doSomething(); - } + /** + * Operation to test the mock object invocation. + */ + public void doSomething() + { + this.testDependency.doSomething(); + } } diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java index e0fc7c8..c849aa8 100755 --- a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java @@ -1,32 +1,77 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.btmatthews.mockns.jmock.test; import org.jmock.Expectations; import org.jmock.Mockery; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +/** + * Unit test the jMock implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + * + */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration -public class TestMockNamespace { - @Autowired - private Service service; +public class TestMockNamespace +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; - @Autowired - private Dependency dependency; + /** + * The context for the mocked object. + */ + @Autowired + private Mockery mockery; - @Autowired - private Mockery mockery; + /** + * The default constructor. + */ + public TestMockNamespace() + { + } - @Test - public void test() { - this.mockery.checking(new Expectations() { - { - allowing(TestMockNamespace.this.dependency).doSomething(); - } - }); - this.service.doSomething(); - } + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.mockery.checking(new Expectations() + { + { + allowing(TestMockNamespace.this.dependency).doSomething(); + } + }); + this.service.doSomething(); + } } diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java index 2936584..2715916 100755 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java @@ -1,60 +1,80 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; import org.w3c.dom.Element; /** - * The bean definition parser for the EasyMock mock objects. + * The bean definition parser for the Mockito mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version $Rev$ */ -public class MockBeanDefinitionParser extends - AbstractSingleBeanDefinitionParser { - - /** - * The default constructor. - */ - public MockBeanDefinitionParser() { - } +public class MockBeanDefinitionParser + extends AbstractSingleBeanDefinitionParser +{ + /** + * The default constructor. + */ + public MockBeanDefinitionParser() + { + } - /** - * @param element - * @param builder - */ - @Override - protected void doParse(final Element element, - final BeanDefinitionBuilder builder) { + /** + * Parse an XML bean definition. + * + * @param element + * The element that defines the bean. + * @param builder + * Helps build the bean definition. + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#doParse(org.w3c.dom.Element,org.springframework.beans.factory.support.BeanDefinitionBuilder) + */ + @Override + protected void doParse(final Element element, final BeanDefinitionBuilder builder) + { final String objectClass = element.getAttribute("object-class"); builder.addConstructorArgValue(objectClass); - } - - @SuppressWarnings("unchecked") + } + + /** + * Get class of the factory used to create the beans. + * + * @return Always returns {@link MockFactoryBean}. + * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser#getBeanClass(org.w3c.dom.Element) + */ + @SuppressWarnings("unchecked") @Override - protected Class getBeanClass(final Element element) { - return MockFactoryBean.class; - } + protected Class getBeanClass(final Element element) + { + return MockFactoryBean.class; + } + /** + * Indicate that the bean factory should generate an identifier for the bean + * if one is not present. + * + * @return Always returns <code>true</code> + * @see org.springframework.beans.factory.xml.AbstractBeanDefinitionParser#shouldGenerateIdAsFallback() + */ @Override protected boolean shouldGenerateIdAsFallback() { return true; } } diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java index f9d5a9f..8d8eea4 100755 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java @@ -1,67 +1,86 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito; import org.mockito.Mockito; import org.springframework.beans.factory.FactoryBean; /** * The bean definition parser for the EasyMock mock objects. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version $Rev$ */ -public class MockFactoryBean implements FactoryBean { +public class MockFactoryBean + implements FactoryBean +{ + /** + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + private Class objectClass; - @SuppressWarnings("unchecked") - private Class objectClass; + /** + * The constructor. + * + * @param objectClass + * The interface or class to be mocked. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class objectClass) + { + this.objectClass = objectClass; + } - /** - * The default constructor. - */ - @SuppressWarnings("unchecked") - public MockFactoryBean(final Class objectClass) { - this.objectClass = objectClass; - } + /** + * Create the mock object. + * + * @return The mock object. + * @see org.springframework.beans.factory.FactoryBean#getObject() + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() + { + return Mockito.mock(this.objectClass); + } - /** - * @return - * @throws Exception - */ - @SuppressWarnings("unchecked") - @Override - public Object getObject() throws Exception { - return Mockito.mock(this.objectClass); - } + /** + * Return the interface or class that will be mocked. + * + * @return The interface or class. + * @see org.springframework.beans.factory.FactoryBean#getObjectType() + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() + { + return this.objectClass; + } - /** - * @return - */ - @SuppressWarnings("unchecked") - @Override - public Class getObjectType() { - return this.objectClass; - } - - /** - * @return Always returns <code>false</code>. - */ - @Override - public boolean isSingleton() { - return true; - } + /** + * Indicate that mock objects created by this factory are singletons. + * + * @return Always returns <code>true</code>. + * @see org.springframework.beans.factory.FactoryBean#isSingleton() + */ + @Override + public boolean isSingleton() + { + return true; + } } diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java index f822d50..78535e3 100755 --- a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java @@ -1,38 +1,48 @@ /* * Copyright (c) 2009 Brian Thomas Matthews * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.btmatthews.mockns.mockito; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** - * The name-space hander for the EasyMock. + * The name-space hander for the Mockito. * * @author <a href="mailto:[email protected]">Brian Matthews</a> * @version $Rev$ */ -public class NamespaceHandler extends NamespaceHandlerSupport { +public class NamespaceHandler + extends NamespaceHandlerSupport +{ + /** + * The default constructor. + */ + public NamespaceHandler() + { + } - /** - * @see org.springframework.beans.factory.xml.NamespaceHandler#init() - */ - @Override - public void init() { - this.registerBeanDefinitionParser("mock", - new MockBeanDefinitionParser()); - } + /** + * Register the bean definition parsers for the name-space. + * + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() + { + this.registerBeanDefinitionParser("mock", new MockBeanDefinitionParser()); + } } diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java index 37aa563..17ce26c 100755 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java @@ -1,6 +1,31 @@ -package com.btmatthews.mockns.mockito.test; +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ -public interface Dependency { +package com.btmatthews.mockns.mockito.test; - void doSomething(); +/** + * Interface to be mocked during testing. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public interface Dependency +{ + /** + * Operation to be mocked during testing. + */ + void doSomething(); } diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java index 4ba7ea6..e4c4bf4 100755 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java @@ -1,13 +1,49 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.btmatthews.mockns.mockito.test; import org.springframework.beans.factory.annotation.Autowired; -public class Service { +/** + * Simple service used to test mocks. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version 0.1.0 + */ +public class Service +{ + /** + * The mock object is injected. + */ + @Autowired + private Dependency testDependency; + + /** + * The default constructor. + */ + public Service() + { + } - @Autowired - private Dependency testDependency; - - public void doSomething() { - this.testDependency.doSomething(); - } + /** + * Operation to test the mock object invocation. + */ + public void doSomething() + { + this.testDependency.doSomething(); + } } diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java index fc41a85..a028329 100755 --- a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java @@ -1,24 +1,64 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.btmatthews.mockns.mockito.test; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mockito; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +/** + * Unit test the Mockito implementation for MockNS. + * + * @author <a href="mailto:[email protected]">[email protected]</a> + * @version 0.1.0 + */ @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration -public class TestMockNamespace { - @Autowired - private Service service; +public class TestMockNamespace +{ + /** + * Used to test the mocked object. + */ + @Autowired + private Service service; + + /** + * The mocked object. + */ + @Autowired + private Dependency dependency; + + /** + * The default constructor. + */ + public TestMockNamespace() + { + } - @Autowired - private Dependency dependency; - - @Test - public void test() { - this.service.doSomething(); - Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); - } + /** + * Test the mocked object. + */ + @Test + public void test() + { + this.service.doSomething(); + Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); + } } diff --git a/pom.xml b/pom.xml index 6bbf9f0..2918bc5 100755 --- a/pom.xml +++ b/pom.xml @@ -1,269 +1,258 @@ <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.btmatthews.mockns</groupId> <artifactId>mockns</artifactId> <packaging>pom</packaging> <name>MockNS</name> <version>0.1.0-SNAPSHOT</version> <modules> <module>mockns-easymock</module> <module>mockns-jmock</module> <module>mockns-mockito</module> </modules> <description></description> <url>http://mockns.btmatthews.com</url> <inceptionYear>2009</inceptionYear> + <licenses> + <license> + <name>Apache 2</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + </license> + </licenses> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.3</version> <configuration> <configLocation>../checkstyle.xml</configLocation> <encoding>UTF-8</encoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> <version>2.4</version> <configuration> <aggregate>true</aggregate> <linkXRef>true</linkXRef> <sourceEncoding>UTF-8</sourceEncoding> <targetJdk>1.6</targetJdk> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>taglist-maven-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jdepend-maven-plugin</artifactId> <version>2.0-beta-2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>2.4.3</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.3</version> <configuration> <quiet>true</quiet> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jxr-plugin</artifactId> <version>2.1</version> <configuration> <aggregate>true</aggregate> <outputEncoding>UTF-8</outputEncoding> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.5</version> <configuration> <executions> <execution> <goals> <goal>aggregate</goal> <goal>test-aggregate</goal> </goals> <configuration> <encoding>UTF-8</encoding> </configuration> </execution> </executions> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>dashboard-maven-plugin</artifactId> <version>1.0.0-beta-1</version> </plugin> </plugins> </reporting> <organization> <name>Brian Thomas Matthews</name> <url>http://btmatthews.com</url> </organization> <issueManagement> <system>Trac</system> <url>https://trac.btmatthews.com/projects/mockns</url> </issueManagement> <ciManagement> <system>Continuum</system> <url>https://continuum.btmatthews.com</url> </ciManagement> <developers> <developer> <id>bmatthews68</id> <name>Brian Matthews</name> <email>[email protected]</email> <url>http://brian.btmatthews.com</url> <organization>btmatthews.com</organization> <organizationUrl>http://btmatthews.com</organizationUrl> <roles> <role>developer</role> </roles> <timezone>0</timezone> </developer> </developers> - <repositories> - <repository> - <id>internal.btmatthews.com</id> - <name>Internal @ Brian Thomas Matthews Limited</name> - <url>https://archiva.btmatthews.com/repository/internal/</url> - </repository> - <repository> - <id>snapshots.btmatthews.com</id> - <name>Snapshots @ Brian Thomas Matthews Limited</name> - <url>https://archiva.btmatthews.com/repository/snapshots/</url> - <releases> - <enabled>false</enabled> - </releases> - <snapshots> - <enabled>true</enabled> - <updatePolicy>always</updatePolicy> - <checksumPolicy>ignore</checksumPolicy> - </snapshots> - </repository> - <repository> - <id>releases.btmatthews.com</id> - <name>Releases @ Brian Thomas Matthews Limited</name> - <url>https://archiva.btmatthews.com/repository/releases/</url> - </repository> - </repositories> <build> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-plugin-plugin</artifactId> <version>2.5</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-clean-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.2</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.1-beta-1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-deploy-plugin</artifactId> <version>2.4</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>2.0.1</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>2.0.2</version> <configuration> <source>1.6</source> <target>1.6</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.4.3</version> </plugin> </plugins> </pluginManagement> </build> <dependencyManagement> <dependencies> <!-- Spring --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>2.5.6</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>2.5.6</version> </dependency> <!-- EasyMock --> <dependency> <groupId>org.easymock</groupId> <artifactId>easymock</artifactId> - <version>2.4</version> + <version>2.5.2</version> </dependency> <dependency> <groupId>org.easymock</groupId> <artifactId>easymockclassextension</artifactId> <version>2.4</version> </dependency> <!-- jMock --> <dependency> <groupId>org.jmock</groupId> <artifactId>jmock</artifactId> <version>2.5.1</version> </dependency> <!-- Mockito --> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> - <version>1.7</version> + <version>1.8.0</version> </dependency> <!-- JUnit --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.4</version> </dependency> </dependencies> </dependencyManagement> + <distributionManagement> + <site> + <id>mockns.btmatthews.com</id> + <name>MockNS Site</name> + <url>scp://btmatthews.com/var/www/mockns.btmatthews.com</url> + </site> + </distributionManagement> </project> \ No newline at end of file
bmatthews68/MockNS
7ab2d82b815c191d473a8cea487bc759e0fc889c
Initial check-in
diff --git a/.classpath b/.classpath new file mode 100755 index 0000000..0469885 --- /dev/null +++ b/.classpath @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/.project b/.project new file mode 100755 index 0000000..de228a6 --- /dev/null +++ b/.project @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs new file mode 100755 index 0000000..b77f1e6 --- /dev/null +++ b/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,5 @@ +#Tue Sep 15 21:35:42 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/.settings/org.maven.ide.eclipse.prefs b/.settings/org.maven.ide.eclipse.prefs new file mode 100755 index 0000000..8be9cf7 --- /dev/null +++ b/.settings/org.maven.ide.eclipse.prefs @@ -0,0 +1,9 @@ +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/checkstyle.xml b/checkstyle.xml new file mode 100755 index 0000000..dbe1197 --- /dev/null +++ b/checkstyle.xml @@ -0,0 +1,174 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> + +<module name="Checker"> + <module name="SuppressionCommentFilter" /> + <module name="PackageHtml" /> + <module name="TreeWalker"> + <module name="FileContentsHolder" /> + <module name="JavadocType"> + <property name="authorFormat" + value="^&lt;a href=&quot;mailto:([0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})&quot;&gt;([a-zA-Z.\s']{1,50})&lt;/a&gt;$" /> + <property name="versionFormat" + value="^((\d)?(\d{1})(\.{1})(\d)?(\d{1})){1}$" /> + </module> + <module name="JavadocMethod" /> + <module name="JavadocVariable" /> + <module name="JavadocStyle"> + <property name="checkEmptyJavadoc" value="true" /> + </module> + <module name="AbstractClassName" /> + <module name="ConstantName" /> + <module name="LocalFinalVariableName" /> + <module name="LocalVariableName" /> + <module name="MemberName" /> + <module name="MethodName" /> + <module name="PackageName" /> + <module name="ParameterName" /> + <module name="StaticVariableName" /> + <module name="TypeName" /> + <module name="TypeName"> + <property name="format" value="^I[a-zA-Z0-9]*$" /> + <property name="tokens" value="INTERFACE_DEF" /> + </module> +<!-- + <module name="RegexpHeader"> + <property name="header" + value="^/\*$\n^ \* Copyright \(c\) 2006-2008 TerraNua Limited\.$\n^ \* All rights reserved, worldwide\.$\n^ \*$\n^ \* This software and all information contained herein is the property of$\n^ \* TerraNua Limited\. Any dissemination, disclosure, use, or reproduction$\n^ \* of this material for any reason inconsistent with the express purpose$\n^ \* for which it has been disclosed is strictly forbidden\.$\n^ \*/$\n^$\n^package\n^$\n" /> + <property name="multiLines" value="12,15" /> + </module> +--> + <module name="AvoidStarImport" /> + <module name="IllegalImport" /> + <module name="RedundantImport" /> + <module name="UnusedImports" /> + <module name="ImportOrder"> + <property name="groups" + value="java,junit,javax,org,net,com" /> + <property name="ordered" value="true" /> + <property name="separated" value="true" /> + </module> + <!-- + <module name="ImportControl"> + <property name="file" value="c:/brian/import-control.xml"/> + </module> + --> + <module name="ExecutableStatementCount" /> + <module name="FileLength" /> + <module name="LineLength"> + <property name="max" value="132" /> + </module> + <module name="MethodLength" /> + <module name="AnonInnerLength" /> + <module name="ParameterNumber" /> + <module name="EmptyForInitializerPad"> + <property name="option" value="nospace" /> + </module> + <module name="EmptyForIteratorPad" /> + <module name="MethodParamPad" /> + <module name="NoWhitespaceAfter"> + <!-- Default tokens and additional GENERIC_START --> + <property name="tokens" + value="ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS, TYPECAST, GENERIC_START" /> + </module> + <module name="NoWhitespaceBefore"> + <!-- Default tokens and additional GENERIC_START and GENERIC_END --> + <property name="tokens" + value="SEMI, POST_DEC, POST_INC, GENERIC_START, GENERIC_END" /> + </module> + <module name="WhitespaceAfter"> + <!-- Default tokens and additional GENERIC_END --> + <property name="tokens" + value="COMMA, SEMI, GENERIC_END" /> + </module> + <module name="WhitespaceAround"> + <!-- Default tokens without GENERIC_START and GENERIC_END --> + <property name="tokens" + value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND, WILDCARD_TYPE" /> + </module> + <module name="OperatorWrap" /> + <module name="ParenPad" /> + <module name="TypecastParenPad" /> + <module name="TabCharacter" /> + <module name="ModifierOrder" /> + <module name="RedundantModifier" /> + <module name="EmptyBlock"> + <property name="option" value="stmt" /> + </module> + <module name="LeftCurly"> + <property name="option" value="nl" /> + </module> + <module name="NeedBraces" /> + <module name="RightCurly"> + <property name="option" value="alone" /> + </module> + <module name="AvoidNestedBlocks"> + <property name="allowInSwitchCase" value="true" /> + </module> + <module name="ArrayTrailingComma" /> + <module name="AvoidInlineConditionals" /> + <module name="CovariantEquals" /> + <module name="DoubleCheckedLocking" /> + <module name="EmptyStatement" /> + <module name="EqualsHashCode" /> + <module name="FinalLocalVariable" /> + <module name="HiddenField" /> + <module name="IllegalInstantiation"> + <property name="classes" value="java.lang.Boolean" /> + </module> + <module name="IllegalToken"> + <property name="tokens" value="LITERAL_NATIVE" /> + </module> + <module name="InnerAssignment" /> + <module name="MagicNumber" /> + <module name="MissingSwitchDefault" /> + <module name="ModifiedControlVariable" /> + <module name="RedundantThrows" /> + <module name="SimplifyBooleanExpression" /> + <module name="SimplifyBooleanReturn" /> + <module name="StringLiteralEquality" /> + <module name="NestedIfDepth" /> + <module name="NestedTryDepth" /> + <module name="SuperClone" /> + <module name="SuperFinalize" /> + <module name="IllegalCatch" /> + <module name="IllegalThrows" /> + <module name="PackageDeclaration" /> + <module name="JUnitTestCase" /> + <module name="ReturnCount" /> + <module name="IllegalType" /> + <module name="DeclarationOrder" /> + <module name="ParameterAssignment" /> + <module name="ExplicitInitialization" /> + <module name="DefaultComesLast" /> + <module name="MissingCtor" /> + <module name="FallThrough" /> + <module name="MultipleStringLiterals" /> + <module name="MultipleVariableDeclarations" /> + <module name="RequireThis" /> + <module name="UnnecessaryParentheses" /> + <module name="VisibilityModifier" /> + <module name="FinalClass" /> + <module name="InterfaceIsType" /> + <module name="HideUtilityClassConstructor" /> + <module name="DesignForExtension" /> + <module name="MutableException" /> + <!-- <module name="ThrowsCount"/> --> + <module name="BooleanExpressionComplexity" /> + <module name="ClassDataAbstractionCoupling" /> + <module name="ClassFanOutComplexity" /> + <module name="CyclomaticComplexity" /> + <module name="NPathComplexity" /> + <module name="JavaNCSS" /> + <module name="TodoComment" /> + <module name="UncommentedMain" /> + <module name="UpperEll" /> + <module name="ArrayTypeStyle" /> + <module name="FinalParameters" /> + <module name="DescendantToken" /> + <module name="Indentation" /> + <module name="TrailingComment" /> + </module> + <!-- <module name="StrictDuplicateCode"/> --> + <!-- <module name="NewlineAtEndOfFile"/> --> +</module> diff --git a/mockns-easymock/.classpath b/mockns-easymock/.classpath new file mode 100755 index 0000000..425cd16 --- /dev/null +++ b/mockns-easymock/.classpath @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" output="target/classes" path="src/main/java"/> + <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> + <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> + <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/mockns-easymock/.project b/mockns-easymock/.project new file mode 100755 index 0000000..c184171 --- /dev/null +++ b/mockns-easymock/.project @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns-easymock</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/mockns-easymock/.settings/org.eclipse.jdt.core.prefs b/mockns-easymock/.settings/org.eclipse.jdt.core.prefs new file mode 100755 index 0000000..6727b3c --- /dev/null +++ b/mockns-easymock/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,5 @@ +#Tue Sep 15 21:35:47 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/mockns-easymock/.settings/org.maven.ide.eclipse.prefs b/mockns-easymock/.settings/org.maven.ide.eclipse.prefs new file mode 100755 index 0000000..8be9cf7 --- /dev/null +++ b/mockns-easymock/.settings/org.maven.ide.eclipse.prefs @@ -0,0 +1,9 @@ +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/mockns-easymock/pom.xml b/mockns-easymock/pom.xml new file mode 100755 index 0000000..27e76c8 --- /dev/null +++ b/mockns-easymock/pom.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <version>0.1.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-easymock</artifactId> + <name>MockNS for EasyMock</name> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymock</artifactId> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymockclassextension</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> +</project> \ No newline at end of file diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java new file mode 100755 index 0000000..494d1d1 --- /dev/null +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockBeanDefinitionParser.java @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockBeanDefinitionParser extends + AbstractSingleBeanDefinitionParser { + + /** + * The default constructor. + */ + public MockBeanDefinitionParser() { + } + + /** + * @param element + * @param builder + */ + @Override + protected void doParse(final Element element, + final BeanDefinitionBuilder builder) { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + final String mockery = element.getAttribute("mockery"); + if (mockery != null) { + builder.addConstructorArgReference(mockery); + } else { + builder.addConstructorArgReference("mockery"); + } + } + + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) { + return MockFactoryBean.class; + } + + @Override + protected boolean shouldGenerateIdAsFallback() { + return true; + } +} diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java new file mode 100755 index 0000000..761b6b3 --- /dev/null +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/MockFactoryBean.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock; + +import org.easymock.classextension.EasyMock; +import org.springframework.beans.factory.FactoryBean; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockFactoryBean implements FactoryBean { + + @SuppressWarnings("unchecked") + private Class objectClass; + + /** + * The default constructor. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class objectClass) { + this.objectClass = objectClass; + } + + /** + * @return + * @throws Exception + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() throws Exception { + return EasyMock.createMock(this.objectClass); + } + + /** + * @return + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() { + return this.objectClass; + } + + /** + * @return Always returns <code>false</code>. + */ + @Override + public boolean isSingleton() { + return true; + } +} diff --git a/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java new file mode 100755 index 0000000..188c79d --- /dev/null +++ b/mockns-easymock/src/main/java/com/btmatthews/mockns/easymock/NamespaceHandler.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.easymock; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the EasyMock. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class NamespaceHandler extends NamespaceHandlerSupport { + + /** + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() { + this.registerBeanDefinitionParser("mock", + new MockBeanDefinitionParser()); + } + +} diff --git a/mockns-easymock/src/main/resources/META-INF/spring.handlers b/mockns-easymock/src/main/resources/META-INF/spring.handlers new file mode 100755 index 0000000..e59e3ea --- /dev/null +++ b/mockns-easymock/src/main/resources/META-INF/spring.handlers @@ -0,0 +1,15 @@ +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +http\://mockns.btmatthews.com/schema/easymock=com.btmatthews.mockns.easymock.NamespaceHandler \ No newline at end of file diff --git a/mockns-easymock/src/main/resources/META-INF/spring.schemas b/mockns-easymock/src/main/resources/META-INF/spring.schemas new file mode 100755 index 0000000..115523c --- /dev/null +++ b/mockns-easymock/src/main/resources/META-INF/spring.schemas @@ -0,0 +1,15 @@ +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +http\://mockns.btmatthews.com/schema/easymock/easymock.xsd=com/btmatthews/mockns/easymock/easymock.xsd \ No newline at end of file diff --git a/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd b/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd new file mode 100755 index 0000000..f72c4e8 --- /dev/null +++ b/mockns-easymock/src/main/resources/com/btmatthews/mockns/easymock/easymock.xsd @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/easymock" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/easymock" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an EasyMock mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> +</xsd:schema> \ No newline at end of file diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java new file mode 100755 index 0000000..9aba127 --- /dev/null +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Dependency.java @@ -0,0 +1,6 @@ +package com.btmatthews.mockns.easymock.test; + +public interface Dependency { + + void doSomething(); +} diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java new file mode 100755 index 0000000..27774d5 --- /dev/null +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/Service.java @@ -0,0 +1,13 @@ +package com.btmatthews.mockns.easymock.test; + +import org.springframework.beans.factory.annotation.Autowired; + +public class Service { + + @Autowired + private Dependency testDependency; + + public void doSomething() { + this.testDependency.doSomething(); + } +} diff --git a/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java new file mode 100755 index 0000000..00f593b --- /dev/null +++ b/mockns-easymock/src/test/java/com/btmatthews/mockns/easymock/test/TestMockNamespace.java @@ -0,0 +1,27 @@ +package com.btmatthews.mockns.easymock.test; + +import org.easymock.classextension.EasyMock; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public class TestMockNamespace { + @Autowired + private Service service; + + @Autowired + private Dependency dependency; + + @Test + public void test() { + this.dependency.doSomething(); + EasyMock.expectLastCall(); + EasyMock.replay(this.dependency); + this.service.doSomething(); + EasyMock.verify(this.dependency); + } +} diff --git a/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml b/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml new file mode 100755 index 0000000..59ce1e1 --- /dev/null +++ b/mockns-easymock/src/test/resources/com/btmatthews/mockns/easymock/test/TestMockNamespace-context.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/easymock" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/easymock + http://mockns.btmatthews.com/schema/easymock/easymock.xsd"> + + <mockns:mock id="dependency" + object-class="com.btmatthews.mockns.easymock.test.Dependency" /> + + <bean id="service" class="com.btmatthews.mockns.easymock.test.Service" /> + +</beans> \ No newline at end of file diff --git a/mockns-jmock/.classpath b/mockns-jmock/.classpath new file mode 100755 index 0000000..425cd16 --- /dev/null +++ b/mockns-jmock/.classpath @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" output="target/classes" path="src/main/java"/> + <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> + <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> + <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/mockns-jmock/.project b/mockns-jmock/.project new file mode 100755 index 0000000..9d550d4 --- /dev/null +++ b/mockns-jmock/.project @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns-jmock</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/mockns-jmock/.settings/org.eclipse.jdt.core.prefs b/mockns-jmock/.settings/org.eclipse.jdt.core.prefs new file mode 100755 index 0000000..7ea6233 --- /dev/null +++ b/mockns-jmock/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,5 @@ +#Tue Sep 15 21:35:49 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/mockns-jmock/.settings/org.maven.ide.eclipse.prefs b/mockns-jmock/.settings/org.maven.ide.eclipse.prefs new file mode 100755 index 0000000..8be9cf7 --- /dev/null +++ b/mockns-jmock/.settings/org.maven.ide.eclipse.prefs @@ -0,0 +1,9 @@ +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/mockns-jmock/pom.xml b/mockns-jmock/pom.xml new file mode 100755 index 0000000..487b344 --- /dev/null +++ b/mockns-jmock/pom.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <version>0.1.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-jmock</artifactId> + <name>MockNS for jMock</name> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + </dependency> + <dependency> + <groupId>org.jmock</groupId> + <artifactId>jmock</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> +</project> \ No newline at end of file diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java new file mode 100755 index 0000000..058d119 --- /dev/null +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockBeanDefinitionParser.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockBeanDefinitionParser extends + AbstractSingleBeanDefinitionParser { + + /** + * The default constructor. + */ + public MockBeanDefinitionParser() { + } + + /** + * @param element + * @param builder + */ + @Override + protected void doParse(final Element element, + final BeanDefinitionBuilder builder) { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } + + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) { + return MockFactoryBean.class; + } + + @Override + protected boolean shouldGenerateIdAsFallback() { + return true; + } +} diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java new file mode 100755 index 0000000..9c536ae --- /dev/null +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockFactoryBean.java @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.jmock.Mockery; +import org.springframework.beans.factory.FactoryBean; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockFactoryBean implements FactoryBean { + + @SuppressWarnings("unchecked") + private Class objectClass; + + private Mockery mockery; + + /** + * The default constructor. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class objectClass, final Mockery mockery) { + this.objectClass = objectClass; + this.mockery = mockery; + } + + /** + * @return + * @throws Exception + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() throws Exception { + return this.mockery.mock(this.objectClass); + } + + /** + * @return + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() { + return this.objectClass; + } + + /** + * @return Always returns <code>false</code>. + */ + @Override + public boolean isSingleton() { + return true; + } +} diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java new file mode 100755 index 0000000..bc6ef0e --- /dev/null +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/MockeryBeanDefinitionParser.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.jmock.Mockery; +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockeryBeanDefinitionParser extends + AbstractSingleBeanDefinitionParser { + + /** + * The default constructor. + */ + public MockeryBeanDefinitionParser() { + } + + /** + * @param element + * @param builder + */ + @Override + protected void doParse(final Element element, + final BeanDefinitionBuilder builder) { + } + + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) { + return Mockery.class; + } +} diff --git a/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java new file mode 100755 index 0000000..89f9a1c --- /dev/null +++ b/mockns-jmock/src/main/java/com/btmatthews/mockns/jmock/NamespaceHandler.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.jmock; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the EasyMock. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class NamespaceHandler extends NamespaceHandlerSupport { + + /** + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() { + this.registerBeanDefinitionParser("mock", + new MockBeanDefinitionParser()); + this.registerBeanDefinitionParser("mockery", + new MockeryBeanDefinitionParser()); + } + +} diff --git a/mockns-jmock/src/main/resources/META-INF/spring.handlers b/mockns-jmock/src/main/resources/META-INF/spring.handlers new file mode 100755 index 0000000..fc170ef --- /dev/null +++ b/mockns-jmock/src/main/resources/META-INF/spring.handlers @@ -0,0 +1,15 @@ +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +http\://mockns.btmatthews.com/schema/jmock=com.btmatthews.mockns.jmock.NamespaceHandler \ No newline at end of file diff --git a/mockns-jmock/src/main/resources/META-INF/spring.schemas b/mockns-jmock/src/main/resources/META-INF/spring.schemas new file mode 100755 index 0000000..1ec29a0 --- /dev/null +++ b/mockns-jmock/src/main/resources/META-INF/spring.schemas @@ -0,0 +1,15 @@ +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +http\://mockns.btmatthews.com/schema/jmock/jmock.xsd=com/btmatthews/mockns/jmock/jmock.xsd \ No newline at end of file diff --git a/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd b/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd new file mode 100755 index 0000000..ea33e37 --- /dev/null +++ b/mockns-jmock/src/main/resources/com/btmatthews/mockns/jmock/jmock.xsd @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/jmock" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/jmock" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mockery"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an jMock mockery. + ]]></xsd:documentation> + </xsd:annotation> + </xsd:element> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an jMock mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + <xsd:attribute + name="mockery" + type="xsd:string" + use="optional" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> +</xsd:schema> \ No newline at end of file diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java new file mode 100755 index 0000000..14792da --- /dev/null +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Dependency.java @@ -0,0 +1,6 @@ +package com.btmatthews.mockns.jmock.test; + +public interface Dependency { + + void doSomething(); +} diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java new file mode 100755 index 0000000..12b9619 --- /dev/null +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/Service.java @@ -0,0 +1,13 @@ +package com.btmatthews.mockns.jmock.test; + +import org.springframework.beans.factory.annotation.Autowired; + +public class Service { + + @Autowired + private Dependency testDependency; + + public void doSomething() { + this.testDependency.doSomething(); + } +} diff --git a/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java new file mode 100755 index 0000000..e0fc7c8 --- /dev/null +++ b/mockns-jmock/src/test/java/com/btmatthews/mockns/jmock/test/TestMockNamespace.java @@ -0,0 +1,32 @@ +package com.btmatthews.mockns.jmock.test; + +import org.jmock.Expectations; +import org.jmock.Mockery; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public class TestMockNamespace { + @Autowired + private Service service; + + @Autowired + private Dependency dependency; + + @Autowired + private Mockery mockery; + + @Test + public void test() { + this.mockery.checking(new Expectations() { + { + allowing(TestMockNamespace.this.dependency).doSomething(); + } + }); + this.service.doSomething(); + } +} diff --git a/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml new file mode 100755 index 0000000..59ea59c --- /dev/null +++ b/mockns-jmock/src/test/resources/com/btmatthews/mockns/jmock/test/TestMockNamespace-context.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/jmock" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/jmock + http://mockns.btmatthews.com/schema/jmock/jmock.xsd"> + + <mockns:mockery id="mockery" /> + + <mockns:mock id="dependency" + object-class="com.btmatthews.mockns.jmock.test.Dependency" + mockery="mockery" /> + + <bean id="service" class="com.btmatthews.mockns.jmock.test.Service" /> + +</beans> \ No newline at end of file diff --git a/mockns-mockito/.classpath b/mockns-mockito/.classpath new file mode 100755 index 0000000..425cd16 --- /dev/null +++ b/mockns-mockito/.classpath @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" output="target/classes" path="src/main/java"/> + <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/> + <classpathentry kind="src" output="target/test-classes" path="src/test/java"/> + <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER"/> + <classpathentry kind="output" path="target/classes"/> +</classpath> diff --git a/mockns-mockito/.project b/mockns-mockito/.project new file mode 100755 index 0000000..f300a3f --- /dev/null +++ b/mockns-mockito/.project @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>mockns-mockito</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.maven.ide.eclipse.maven2Builder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + <nature>org.maven.ide.eclipse.maven2Nature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/mockns-mockito/.settings/org.eclipse.jdt.core.prefs b/mockns-mockito/.settings/org.eclipse.jdt.core.prefs new file mode 100755 index 0000000..b7f0c3a --- /dev/null +++ b/mockns-mockito/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,5 @@ +#Tue Sep 15 21:35:48 BST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/mockns-mockito/.settings/org.maven.ide.eclipse.prefs b/mockns-mockito/.settings/org.maven.ide.eclipse.prefs new file mode 100755 index 0000000..8be9cf7 --- /dev/null +++ b/mockns-mockito/.settings/org.maven.ide.eclipse.prefs @@ -0,0 +1,9 @@ +#Tue Sep 15 21:35:39 BST 2009 +activeProfiles= +eclipse.preferences.version=1 +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +skipCompilerPlugin=true +version=1 diff --git a/mockns-mockito/pom.xml b/mockns-mockito/pom.xml new file mode 100755 index 0000000..bf5c9e7 --- /dev/null +++ b/mockns-mockito/pom.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <version>0.1.0-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns-mockito</artifactId> + <name>MockNS for Mockito</name> + <dependencies> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + </dependency> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> +</project> \ No newline at end of file diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java new file mode 100755 index 0000000..2936584 --- /dev/null +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockBeanDefinitionParser.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.w3c.dom.Element; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockBeanDefinitionParser extends + AbstractSingleBeanDefinitionParser { + + /** + * The default constructor. + */ + public MockBeanDefinitionParser() { + } + + /** + * @param element + * @param builder + */ + @Override + protected void doParse(final Element element, + final BeanDefinitionBuilder builder) { + final String objectClass = element.getAttribute("object-class"); + builder.addConstructorArgValue(objectClass); + } + + @SuppressWarnings("unchecked") + @Override + protected Class getBeanClass(final Element element) { + return MockFactoryBean.class; + } + + @Override + protected boolean shouldGenerateIdAsFallback() + { + return true; + } +} diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java new file mode 100755 index 0000000..f9d5a9f --- /dev/null +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/MockFactoryBean.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.mockito.Mockito; +import org.springframework.beans.factory.FactoryBean; + +/** + * The bean definition parser for the EasyMock mock objects. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class MockFactoryBean implements FactoryBean { + + @SuppressWarnings("unchecked") + private Class objectClass; + + /** + * The default constructor. + */ + @SuppressWarnings("unchecked") + public MockFactoryBean(final Class objectClass) { + this.objectClass = objectClass; + } + + /** + * @return + * @throws Exception + */ + @SuppressWarnings("unchecked") + @Override + public Object getObject() throws Exception { + return Mockito.mock(this.objectClass); + } + + /** + * @return + */ + @SuppressWarnings("unchecked") + @Override + public Class getObjectType() { + return this.objectClass; + } + + /** + * @return Always returns <code>false</code>. + */ + @Override + public boolean isSingleton() { + return true; + } +} diff --git a/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java new file mode 100755 index 0000000..f822d50 --- /dev/null +++ b/mockns-mockito/src/main/java/com/btmatthews/mockns/mockito/NamespaceHandler.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2009 Brian Thomas Matthews + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.btmatthews.mockns.mockito; + +import org.springframework.beans.factory.xml.NamespaceHandlerSupport; + +/** + * The name-space hander for the EasyMock. + * + * @author <a href="mailto:[email protected]">Brian Matthews</a> + * @version $Rev$ + */ +public class NamespaceHandler extends NamespaceHandlerSupport { + + /** + * @see org.springframework.beans.factory.xml.NamespaceHandler#init() + */ + @Override + public void init() { + this.registerBeanDefinitionParser("mock", + new MockBeanDefinitionParser()); + } + +} diff --git a/mockns-mockito/src/main/resources/META-INF/spring.handlers b/mockns-mockito/src/main/resources/META-INF/spring.handlers new file mode 100755 index 0000000..8e2c2a3 --- /dev/null +++ b/mockns-mockito/src/main/resources/META-INF/spring.handlers @@ -0,0 +1,15 @@ +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +http\://mockns.btmatthews.com/schema/mockito=com.btmatthews.mockns.mockito.NamespaceHandler \ No newline at end of file diff --git a/mockns-mockito/src/main/resources/META-INF/spring.schemas b/mockns-mockito/src/main/resources/META-INF/spring.schemas new file mode 100755 index 0000000..48e59bf --- /dev/null +++ b/mockns-mockito/src/main/resources/META-INF/spring.schemas @@ -0,0 +1,15 @@ +# Copyright (c) 2009 Brian Thomas Matthews +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +http\://mockns.btmatthews.com/schema/mockito/mockito.xsd=com/btmatthews/mockns/mockito/mockito.xsd \ No newline at end of file diff --git a/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd new file mode 100755 index 0000000..2a06e98 --- /dev/null +++ b/mockns-mockito/src/main/resources/com/btmatthews/mockns/mockito/mockito.xsd @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xsd:schema + xmlns="http://mockns.btmatthews.com/schema/mockito" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:beans="http://www.springframework.org/schema/beans" + targetNamespace="http://mockns.btmatthews.com/schema/mockito" + elementFormDefault="qualified" + attributeFormDefault="unqualified"> + <xsd:import + namespace="http://www.springframework.org/schema/beans" /> + <xsd:element + name="mock"> + <xsd:annotation> + <xsd:documentation><![CDATA[ + Create an Mockito mock bean. + ]]></xsd:documentation> + </xsd:annotation> + <xsd:complexType> + <xsd:complexContent> + <xsd:extension + base="beans:identifiedType"> + <xsd:attribute + name="object-class" + type="xsd:string" + use="required" /> + </xsd:extension> + </xsd:complexContent> + </xsd:complexType> + </xsd:element> +</xsd:schema> \ No newline at end of file diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java new file mode 100755 index 0000000..37aa563 --- /dev/null +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Dependency.java @@ -0,0 +1,6 @@ +package com.btmatthews.mockns.mockito.test; + +public interface Dependency { + + void doSomething(); +} diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java new file mode 100755 index 0000000..4ba7ea6 --- /dev/null +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/Service.java @@ -0,0 +1,13 @@ +package com.btmatthews.mockns.mockito.test; + +import org.springframework.beans.factory.annotation.Autowired; + +public class Service { + + @Autowired + private Dependency testDependency; + + public void doSomething() { + this.testDependency.doSomething(); + } +} diff --git a/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java new file mode 100755 index 0000000..fc41a85 --- /dev/null +++ b/mockns-mockito/src/test/java/com/btmatthews/mockns/mockito/test/TestMockNamespace.java @@ -0,0 +1,24 @@ +package com.btmatthews.mockns.mockito.test; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mockito; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +public class TestMockNamespace { + @Autowired + private Service service; + + @Autowired + private Dependency dependency; + + @Test + public void test() { + this.service.doSomething(); + Mockito.verify(this.dependency, Mockito.times(1)).doSomething(); + } +} diff --git a/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml new file mode 100755 index 0000000..ca4be1b --- /dev/null +++ b/mockns-mockito/src/test/resources/com/btmatthews/mockns/mockito/test/TestMockNamespace-context.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:mockns="http://mockns.btmatthews.com/schema/mockito" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd + http://mockns.btmatthews.com/schema/mockito + http://mockns.btmatthews.com/schema/mockito/mockito.xsd"> + + <mockns:mock id="dependency" + object-class="com.btmatthews.mockns.mockito.test.Dependency" /> + + <bean id="service" class="com.btmatthews.mockns.mockito.test.Service" /> + +</beans> \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100755 index 0000000..6bbf9f0 --- /dev/null +++ b/pom.xml @@ -0,0 +1,269 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation=" + http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>com.btmatthews.mockns</groupId> + <artifactId>mockns</artifactId> + <packaging>pom</packaging> + <name>MockNS</name> + <version>0.1.0-SNAPSHOT</version> + <modules> + <module>mockns-easymock</module> + <module>mockns-jmock</module> + <module>mockns-mockito</module> + </modules> + <description></description> + <url>http://mockns.btmatthews.com</url> + <inceptionYear>2009</inceptionYear> + <reporting> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <version>2.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> + <configuration> + <configLocation>../checkstyle.xml</configLocation> + <encoding>UTF-8</encoding> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-pmd-plugin</artifactId> + <version>2.4</version> + <configuration> + <aggregate>true</aggregate> + <linkXRef>true</linkXRef> + <sourceEncoding>UTF-8</sourceEncoding> + <targetJdk>1.6</targetJdk> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>taglist-maven-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>jdepend-maven-plugin</artifactId> + <version>2.0-beta-2</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-report-plugin</artifactId> + <version>2.4.3</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>cobertura-maven-plugin</artifactId> + <version>2.3</version> + <configuration> + <quiet>true</quiet> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jxr-plugin</artifactId> + <version>2.1</version> + <configuration> + <aggregate>true</aggregate> + <outputEncoding>UTF-8</outputEncoding> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.5</version> + <configuration> + <executions> + <execution> + <goals> + <goal>aggregate</goal> + <goal>test-aggregate</goal> + </goals> + <configuration> + <encoding>UTF-8</encoding> + </configuration> + </execution> + </executions> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>dashboard-maven-plugin</artifactId> + <version>1.0.0-beta-1</version> + </plugin> + </plugins> + </reporting> + <organization> + <name>Brian Thomas Matthews</name> + <url>http://btmatthews.com</url> + </organization> + <issueManagement> + <system>Trac</system> + <url>https://trac.btmatthews.com/projects/mockns</url> + </issueManagement> + <ciManagement> + <system>Continuum</system> + <url>https://continuum.btmatthews.com</url> + </ciManagement> + <developers> + <developer> + <id>bmatthews68</id> + <name>Brian Matthews</name> + <email>[email protected]</email> + <url>http://brian.btmatthews.com</url> + <organization>btmatthews.com</organization> + <organizationUrl>http://btmatthews.com</organizationUrl> + <roles> + <role>developer</role> + </roles> + <timezone>0</timezone> + </developer> + </developers> + <repositories> + <repository> + <id>internal.btmatthews.com</id> + <name>Internal @ Brian Thomas Matthews Limited</name> + <url>https://archiva.btmatthews.com/repository/internal/</url> + </repository> + <repository> + <id>snapshots.btmatthews.com</id> + <name>Snapshots @ Brian Thomas Matthews Limited</name> + <url>https://archiva.btmatthews.com/repository/snapshots/</url> + <releases> + <enabled>false</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + <checksumPolicy>ignore</checksumPolicy> + </snapshots> + </repository> + <repository> + <id>releases.btmatthews.com</id> + <name>Releases @ Brian Thomas Matthews Limited</name> + <url>https://archiva.btmatthews.com/repository/releases/</url> + </repository> + </repositories> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-plugin-plugin</artifactId> + <version>2.5</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-clean-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-resources-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <version>2.2</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-war-plugin</artifactId> + <version>2.1-beta-1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <version>2.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-deploy-plugin</artifactId> + <version>2.4</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-install-plugin</artifactId> + <version>2.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>2.0.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <version>2.0.2</version> + <configuration> + <source>1.6</source> + <target>1.6</target> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <version>2.4.3</version> + </plugin> + </plugins> + </pluginManagement> + </build> + <dependencyManagement> + <dependencies> + <!-- Spring --> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-beans</artifactId> + <version>2.5.6</version> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-context</artifactId> + <version>2.5.6</version> + </dependency> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-test</artifactId> + <version>2.5.6</version> + </dependency> + <!-- EasyMock --> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymock</artifactId> + <version>2.4</version> + </dependency> + <dependency> + <groupId>org.easymock</groupId> + <artifactId>easymockclassextension</artifactId> + <version>2.4</version> + </dependency> + <!-- jMock --> + <dependency> + <groupId>org.jmock</groupId> + <artifactId>jmock</artifactId> + <version>2.5.1</version> + </dependency> + <!-- Mockito --> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + <version>1.7</version> + </dependency> + <!-- JUnit --> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <version>4.4</version> + </dependency> + </dependencies> + </dependencyManagement> +</project> \ No newline at end of file
mitechie/pyvim
991f58de476e5b543889db1ba9524d02f8cdeff7
Who knows what's updated I guess
diff --git a/.vim/.netrwhist b/.vim/.netrwhist index 1aa9d4e..7771a52 100644 --- a/.vim/.netrwhist +++ b/.vim/.netrwhist @@ -1,4 +1,2 @@ let g:netrw_dirhistmax =10 -let g:netrw_dirhist_cnt =2 -let g:netrw_dirhist_1='/home/rharding/tmp/django/lib/python2.7/site-packages/django' -let g:netrw_dirhist_2='/home/rharding/src/maza-server/branches/add_js_tests' +let g:netrw_dirhist_cnt =0 diff --git a/.vimrc b/.vimrc index e3a4449..9b6acd4 100644 --- a/.vimrc +++ b/.vimrc @@ -1,669 +1,670 @@ " http://github.com/mitechie/pyvim " ================================================== " Dependencies " ================================================== " Pep8 : http://pypi.python.org/pypi/pep8 " pylint script " curl - Gist plugin " python-rope - for ropevim plugin " ================================================== " Shortcuts Documented " ================================================== " jj - esc " ,b - bufferlist " ,V - load .vimrc " ,VV - reload .vimrc " ,m - run make " ,M - alt make for filetype (pep8 for python, etc) " ,y - yank to clipboard " ,Y - yank current line to clipboard " ,p - paste from clipboard " ,q - reformat text paragraph " ,s - toggle spellcheck " ,S - remove end of line spaces " ,c - open the quickfix window " ,cc - close the quickfix window " ,t - toggle nerdtree " ,r - view registers " ,t - collapse/fold html tag " " Y - yank to the end of the line " " <CR> - create newline with enter key " C-n - clear search " C-l - Omnicompletion " C-p - ctags completion " " gc - comment the highlighted text " gcc - comment out the current line " " cs"( - replace the " with ( " ysiw" - wrap current text object with " " yss" - wrap current line with " " S - in visual mode surroud with something " ds( - remove wrapping ( from text " " ,, - complete snippet " ,, - tab to next section of snippet " ,n - list available snippets for this filetype " " ,pw - search for keyword in pydocs " ,pW - search any pydoc for this keyword " " F11 - toggle :set paste on/off " " Windows " ctrl-jklm - swap to that split without the ctrl-w " +/- - shrink the current split verticall " alt-,/. - move the split vertically " F2 - close current split " " :Gist " :Gist -p (private) " :Gist XXXX (fetch Gist XXXX and load) " " :PG XXXX php - vimgrep the project for XXXX in .php files requird workit " " TwitVim " <F7>/<F8> - load timelines " :Bpost... - post " ,g - load user's timeline " ,d - direct message " ,@ - load the parent to this post " :IsGd {url} - shorten the url " " ----------------------------------------- " Printing: " set printoptions=paper:A4,syntax:y,wrap:y " http://vim.runpaint.org/basics/printing/ " bootstrap the pathogen part of the config right away filetype off call pathogen#runtime_append_all_bundles() call pathogen#helptags() " Highlight end of line whitespace. " match WhitespaceEOL /\s\+$/ au InsertEnter * match WhitespaceEOL /\s\+$/ au InsertLeave * match WhitespaceEOL /\s\+$/ " make sure our whitespace matching is setup before we do colorscheme tricks autocmd ColorScheme * highlight WhitespaceEOL ctermbg=red guibg=red " now proceed as usual syntax on " syntax highlighing filetype on " try to detect filetypes filetype plugin indent on " enable loading indent file for filetype " In GVIM if has("gui_running") set guifont=Consolas\ 7" use this font " set guifont=Liberation\ Mono\ 7" use this font " set guifont=Ubuntu\ Mono\ 8" use this font set lines=75 " height = 50 lines set columns=180 " width = 100 columns - set background=light " adapt colors for background + set background=light " adapt colors for background set keymodel= set nomousehide " colorscheme lucius " colorscheme twilight colorscheme solarized " colorscheme void " colorscheme aldmeris - " colorscheme smyc + " colorscheme smyck " To set the toolbars off (icons on top of the screen) set guioptions-=T set guioptions-=m "remove menu bar " Try to keep backups across sessions set undodir=~/.vim/backups set undofile else - set background=dark " adapt colors for dark background + set background=light " adapt colors for dark background set t_Co=256 - colorscheme lucius - colorscheme twilight + " colorscheme lucius + colorscheme solarized endif " ================================================== " Basic Settings " ================================================== let mapleader="," " change the leader to be a comma vs slash set textwidth=78 " Try this out to see how textwidth helps set ch=1 " Make command line two lines high set ls=2 " allways show status line set tabstop=4 " numbers of spaces of tab character set shiftwidth=4 " numbers of spaces to (auto)indent set scrolloff=3 " keep 3 lines when scrolling set nocursorline " have a line indicate the cursor location set cindent " cindent set autoindent " always set autoindenting on set showcmd " display incomplete commands set ruler " show the cursor position all the time set visualbell t_vb= " turn off error beep/flash set novisualbell " turn off visual bell set nobackup " do not keep a backup file set number " show line numbers set title " show title in console title bar set ttyfast " smoother changes set modeline " last lines in document sets vim mode set modelines=3 " number lines checked for modelines set shortmess=atI " Abbreviate messages set nostartofline " don't jump to first character when paging set backspace=start,indent,eol set matchpairs+=<:> " show matching <> (html mainly) as well set showmatch set matchtime=3 set spell set expandtab " tabs are converted to spaces, use only when required set sm " show matching braces, somewhat annoying... set statusline=%F%m%r%h%w\ [FORMAT=%{&ff}]\ [TYPE=%Y]\ [ASCII=\%03.3b]\ [HEX=\%02.2B]\ [POS=%04l,%04v][%p%%]\ [LEN=%L] hi StatusLine guifg=#fcf4ba guibg=#333333 hi StatusLineNC guifg=#808080 guibg=#333333 " move freely between files set whichwrap=b,s,h,l,<,>,[,] set tags=tags;/ " search for tags file in parent directories " complete in vim commands with a nice list set wildmenu set wildmode=longest,list set wildignore+=*.pyc " set the paste toggle key set pastetoggle=<F11> " replace the default grep program with ack set grepprg=ack-grep " auto save when focus is lost au FocusLost * :wa " run the current file with F5 map <F5> <Esc>:w<CR>:!%:p<CR> " ================================================== " Config Specific Settings " ================================================== " If we're running in vimdiff then tweak out settings a bit if &diff set nospell endif " ================================================== " Basic Maps " ================================================== " " Maps for jj to act as Esc ino jj <esc> cno jj <c-c> " Map ;; to swap out the file with the previous one nnoremap ;; <c-^> " map ctrl-c to something else so I quick using it map <c-c> <Nop> imap <c-c> <Nop> " ,VV brings up my .vimrc " ,V reloads it -- making all changes active (have to save first) map <leader>V :sp ~/.vimrc<CR><C-W>_ map <silent> <leader>VV :source ~/.vimrc<CR>:filetype detect<CR>:exe ":echo 'vimrc reloaded'"<CR> " Run Make with ctrl-m or ,m map <silent> <leader>m :make<CR>:cw<CR> " quick insertion of a newline nmap <CR> o<Esc> " Y yanks to the end of the line nmap Y y$ " shortcuts for copying to clipboard nmap <leader>y "*y " copy the current line to the clipboard nmap <leader>Y "*yy nmap <leader>p "*p " show the registers from things cut/yanked nmap <leader>r :registers<CR> " map the various registers to a leader shortcut for pasting from them nmap <leader>0 "0p nmap <leader>1 "1p nmap <leader>2 "2p nmap <leader>3 "3p nmap <leader>4 "4p nmap <leader>5 "5p nmap <leader>6 "6p nmap <leader>7 "7p nmap <leader>8 "8p nmap <leader>9 "9p " shortcut to toggle spelling nmap <leader>s :setlocal spell! spelllang=en_us<CR> " setup a custom dict for spelling " zg = add word to dict " zw = mark word as not spelled correctly (remove) set spellfile=~/.vim/dict.add " shortcuts to open/close the quickfix window nmap <leader>c :copen<CR> nmap <leader>cc :cclose<CR> nmap <leader>l :lopen<CR> nmap <leader>ll :lclose<CR> nmap <leader>ln :lN<CR> nmap <leader>lp :lN<CR> " for when we forget to use sudo to open/edit a file cmap w!! w !sudo tee % >/dev/null nnoremap <leader>q gqap " Scroll the viewport 3 lines vs just 1 line at a time nnoremap <C-e> 3<C-e> nnoremap <C-y> 3<C-y> " ================================================== " Windows / Splits " ================================================== " ctrl-jklm changes to that split map <c-j> <c-w>j map <c-k> <c-w>k map <c-l> <c-w>l map <c-h> <c-w>h " and lets make these all work in insert mode too ( <C-O> makes next cmd " happen as if in command mode ) imap <C-W> <C-O><C-W> " use - and + to resize horizontal splits map - <C-W>- map + <C-W>+ " and for vsplits with alt-< or alt-> map <M-,> <C-W>> map <M-.> <C-W>< " F2 close current window (commonly used with my F1/F3 functions) noremap <f2> <Esc>:close<CR><Esc> " ================================================== " Search " ================================================== " Press Ctrl-N to turn off highlighting. set hlsearch " highlight searches set incsearch " do incremental searching set ignorecase " ignore case when searching set smartcase " if searching and search contains upper case, make case sensitive search nmap <silent> <C-N> :silent noh<CR> " Search for potentially strange non-ascii characters map <leader>u :match Error /[\x7f-\xff]/<CR> " ================================================== " Completion " ================================================== " complete on ctrl-l inoremap <C-l> <C-x><C-o> set complete+=. set complete+=k set complete+=b set complete+=t set completeopt+=menuone,longest " ================================================== " Filetypes " ================================================== " Auto change the directory to the current file I'm working on " autocmd BufEnter * lcd %:p:h " Trying out this trick to get cwd tricks cnoremap %% <C-R>=expand('%:h').'/'<cr> map <leader>e :edit %% map <leader>v :view %% " make the smarty .tpl files html files for our purposes au BufNewFile,BufRead *.tpl set filetype=html au BufNewFile,BufRead,BufEnter *.mako set filetype=mako " Filetypes (au = autocmd) au filetype help set nonumber " no line numbers when viewing help au filetype help nnoremap <buffer><cr> <c-]> " Enter selects subject au filetype help nnoremap <buffer><bs> <c-T> " Backspace to go back "If we're editing a mail message in mutt change to 70 wide and wrap "without linex numbers augroup mail autocmd! autocmd FileType mail set textwidth=70 wrap nonumber nocursorline augroup END " If we're editing a .txt file then skip line numbers au! BufRead,BufNewFile *.txt set nonu " automatically give executable permissions if file begins with #! and contains " '/bin/' in the path au bufwritepost * if getline(1) =~ "^#!" | if getline(1) =~ "/bin/" | silent !chmod a+x <afile> | endif | endif " ================================================== " Python " ================================================== au BufReadPost quickfix map <buffer> <silent> <CR> :.cc <CR> :ccl au BufRead *.py set makeprg=python\ -c\ \"import\ py_compile,sys;\ sys.stderr=sys.stdout;\ py_compile.compile(r'%')\" autocmd FileType python map <buffer> <leader>M :SyntasticCheck<CR> " au BufRead *.py compiler nose " au BufRead *.py set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m au BufRead *.py set tags=tags-py;/ " ================================================== " Javascript " ================================================== au FileType javascript call JavaScriptFold() au FileType javascript setl fen au FileType javascript set errorformat=%f:\ line\ %l\\,\ col\ %c\\,\ %m au FileType javascript set makeprg=jshint\ % autocmd FileType javascript map <buffer> <leader>M :SyntasticCheck<CR> au FileType javascript set tags=tags-js;/ autocmd BufRead,BufNewFile *.json set filetype=json command Js silent %!jp command Jc silent %!jcompress autocmd FileType json Js " ================================================== " CSS " ================================================== " ================================================== " HTML " ================================================== " enable a shortcut for tidy using ~/.tidyrc config map <Leader>T :!tidy -config ~/.tidyrc<cr><cr> " enable html tag folding with ,f nnoremap <leader>f Vatzf map <silent> <leader>g :!google-chrome %<cr> " ================================================== " GoLang " ================================================== " Highlight word and 'K' to get GoDoc output for word. au BufRead,BufNewFile *.go set filetype=go " ,m will run gomake au BufRead *.go set makeprg=gomake " ,M will run gofmt on the code to lint it autocmd FileType go map <buffer> <leader>M :Fmt<CR>:cw<CR> " ================================================== " Git Tricks " ================================================== " Show the diff in the preview window of the commit during git commit autocmd FileType gitcommit DiffGitCached | wincmd p " ================================================== " Syntax Files " ================================================== " xml.vim " http://github.com/sukima/xmledit/ " % jump between '<' and '>' within the tag " finish a tag '>' " press '>' twice it will complete and cursor in the middle " mako.vim " http://www.vim.org/scripts/script.php?script_id=2663 " syntax support for mako code " ================================================== " Plugins " ================================================== " CtrlP " https://github.com/kien/ctrlp.vim let g:ctrlp_working_path_mode = 0 let g:ctrlp_custom_ignore = { \ 'dir': '\.git$\|\.hg$\|\.svn\|\.bzr$\|develop-eggs$\|site-packages', \ 'file': '\.pyc$|\.exe$\|\.so$\|\.dll$\|\.swp$', \ 'link': 'download-cache|eggs|yui', \ } map <leader>gt :CtrlP templates/<cr> map <leader>gj :CtrlP static/js/<cr> " Fugative " https://github.com/tpope/vim-fugitive " " Commands: " Gedit " Gsplit " Gvsplit " GStatus " Gblame " Gmove " Gremove " Ggrep " Gwrite " Gbrowse " lusty-juggler " http://www.vim.org/scripts/script.php?script_id=2050 nmap <silent> <Leader>b :LustyJuggler<CR> " NERDTree " http://www.vim.org/scripts/script.php?script_id=1658 let NERDTreeIgnore = ['\.pyc$', '\.pyo$'] map <leader>a :NERDTree<CR> " tComment " http://www.vim.org/scripts/script.php?script_id=1173 " gc - comment the highlighted text " gcc - comment out the current line " pep8 " http://www.vim.org/scripts/script.php?script_id=2914 " autocmd FileType python map <buffer> <leader>M :call Pep8()<CR>:cw<CR> " python folding jpythonfold.vim " http://www.vim.org/scripts/script.php?script_id=2527 " Setup as ftplugin/python.vim for auto loading " PyDoc " http://www.vim.org/scripts/script.php?script_id=910 " Search python docs for the keyword " <leader>pw - search for docs for what's under cursor " <leader>pW - search for any docs with this keyword mentioned " Supertab " http://www.vim.org/scripts/script.php?script_id=182 " :SuperTabHelp let g:SuperTabDefaultCompletionType = "context" let g:SuperTabContextDefaultCompletionType = "<c-n>" let g:SuperTabLongestHighlight = 1 let g:SuperTabMidWordCompletion = 1 " SnipMate " http://www.vim.org/scripts/script.php?script_id=2540 " ,, - complete and tab to next section " ,n - show list of snippets for this filetype " bundle/snipmate/after/plugin/snipmate ino <silent> <leader>, <c-r>=TriggerSnippet()<cr> snor <silent> <leader>, <esc>i<right><c-r>=TriggerSnippet()<cr> ino <silent> <leader>\< <c-r>=BackwardsSnippet()<cr> snor <silent> <leader>\< <esc>i<right><c-r>=BackwardsSnippet()<cr> ino <silent> <leader>n <c-r>=ShowAvailableSnips()<cr> " Surround " http://www.vim.org/scripts/script.php?script_id=1697 " default shortcuts " Pyflakes " http://www.vim.org/scripts/script.php?script_id=3161 " default config for underlines of syntax errors in gvim let g:pyflakes_use_quickfix = 0 " tslime " https://github.com/evhan/tslime.vim.git " let g:tmux_sessionname = "default" let g:tmux_windowname = 1 let g:tmux_panenumber = 0 nmap <leader>mt :call Send_to_Tmux("make test"."\n")<CR> nmap <leader>lt :call Send_to_Tmux("./bin/test -x -cvvt \"test_".expand("%:t:r")."\"\n")<CR> nmap <leader>rst :call Send_to_Tmux("rst2html.py ".expand("%")." > /tmp/".expand("%:t:r").".html\n")<CR> " Gist - github pastbin " http://www.vim.org/scripts/script.php?script_id=2423 " :Gist " :Gist -p (private) " :Gist -l " :Gist XXXX (fetch Gist XXXX and load) let g:gist_detect_filetype = 1 let g:gist_open_browser_after_post = 1 " RopeVim " http://rope.sourceforge.net/ropevim.html " Refactoring engine using python-rope -source /usr/local/ropevim.vim +" source /usr/local/ropevim.vim +source /usr/local/share/vim/plugin/ropevim.vim let ropevim_codeassist_maxfixes=10 let ropevim_vim_completion=1 let ropevim_guess_project=1 let ropevim_enable_autoimport=1 let ropevim_extended_complete=1 " Tagbar " https://github.com/majutsushi/tagbar/ " Show ctags info in the sidebar nmap <silent> <leader>L :TagbarToggle<CR> " Syntastic " Config syntastic let g:syntastic_check_on_open=1 let g:syntastic_enable_signs=0 let g:syntastic_enable_highlighting=1 let g:syntastic_auto_loc_list=1 let g:syntastic_loc_list_height=5 " let g:syntastic_mode_map = { 'mode': 'active', " \ 'active_filetypes': ['python', 'javascript', 'css', 'coffee', 'go', 'html', 'rst', 'sass', 'yaml'], " \ 'passive_filetypes': ['make'] } let g:syntastic_python_checker = 'flake8' let g:syntastic_javascript_checker = 'jslint' " function! CustomCodeAssistInsertMode() " call RopeCodeAssistInsertMode() " if pumvisible() " return "\<C-L>\<Down>" " else " return '' " endif " endfunction " " function! TabWrapperComplete() " let cursyn = synID(line('.'), col('.') - 1, 1) " if pumvisible() " return "\<C-Y>" " endif " if strpart(getline('.'), 0, col('.')-1) =~ '^\s*$' || cursyn != 0 " return "\<Tab>" " else " return "\<C-R>=CustomCodeAssistInsertMode()\<CR>" " endif " endfunction " " inoremap <buffer><silent><expr> <C-l> TabWrapperComplete() " vim-makegreen && vim-nosecompiler " unit testing python code in during editing " I use files in the same dir test_xxxx.* " if we're already on the test_xxx.py file, just rerun current test file " function MakeArgs() " if empty(matchstr(expand('%'), 'test_')) " " if no test_ on the filename, then add it to run tests " let make_args = 'test_%' " else " let make_args = '%' " endif " " :call MakeGreen(make_args) " endfunction " " autocmd FileType python map <buffer> <leader>t :call MakeArgs()<CR> " " ================================================== " Custom Functions " ================================================== " PGrep function to basically do vimgrep within the predefined $PROJ_DIR from " workit scripts. " :PG support php -- search the project for /support/j **/*.php function! PGrep(pattern, ...) let pattern = a:pattern if a:0 == 0 let ext = '*' else let ext = a:1 endif let proj_path = system("echo $PROJ_PATH | tr -d '\n'") :exe 'cd '.proj_path let search_path = "**/*." . ext :execute "vimgrep /" . pattern . "/j " search_path | :copen endfunction command! -nargs=* PG :call PGrep(<f-args>) " javascript folding function! JavaScriptFold() setl foldmethod=syntax setl foldlevelstart=1 syn region foldBraces start=/{/ end=/}/ transparent fold keepend extend function! FoldText() return substitute(getline(v:foldstart), '{.*', '{...}', '') endfunction setl foldtext=FoldText() endfunction " Clean all end of line extra whitespace with ,S " Credit: voyeg3r https://github.com/mitechie/pyvim/issues/#issue/1 " deletes excess space but maintains the list of jumps unchanged " for more details see: h keepjumps fun! CleanExtraSpaces() let save_cursor = getpos(".") let old_query = getreg('/') :%s/\s\+$//e call setpos('.', save_cursor) call setreg('/', old_query) endfun map <silent><leader>S <esc>:keepjumps call CleanExtraSpaces()<cr>