* fixed a bug in Objects' DictionaryCollection where getKeys and getKeysAndValues methods returned date keys without copying them first (since date values are mutable, this could corrupt dictionary's internal state if user subsequently modified those dates)

hhas · hhas · commit 9134eb8356d8 · 2016-04-22T11:45:53.000+01:00
* in Web, renamed `escape/unescape URL characters` and `parse/format JSON` handlers; added `encode/decode Base64` handlers; tidied `send HTTP request` implementation

* in File and Web, rejigged `_NSStringEncodings` to eliminate magic numbers

* updated TO DOs
diff --git a/File.scptd/Contents/Info.plist b/File.scptd/Contents/Info.plist
@@ -15,17 +15,17 @@
 		<key>bundleDividerCollapsed</key>
 		<false/>
 		<key>bundlePositionOfDivider</key>
-		<real>839</real>
+		<real>755</real>
 		<key>dividerCollapsed</key>
 		<false/>
 		<key>eventLogLevel</key>
 		<integer>0</integer>
 		<key>name</key>
 		<string>ScriptWindowState</string>
 		<key>positionOfDivider</key>
-		<real>524</real>
+		<real>683</real>
 		<key>savedFrame</key>
-		<string>116 33 1088 744 0 0 1280 777 </string>
+		<string>719 140 1004 903 0 0 1920 1057 </string>
 		<key>selectedTab</key>
 		<string>log</string>
 	</dict>
diff --git a/File.scptd/Contents/Resources/Scripts/main.scpt b/File.scptd/Contents/Resources/Scripts/main.scpt
diff --git a/Objects.scptd/Contents/Info.plist b/Objects.scptd/Contents/Info.plist
@@ -23,9 +23,9 @@
 		<key>name</key>
 		<string>ScriptWindowState</string>
 		<key>positionOfDivider</key>
-		<real>521</real>
+		<real>800</real>
 		<key>savedFrame</key>
-		<string>123 33 982 744 0 0 1280 777 </string>
+		<string>538 34 982 1023 0 0 1920 1057 </string>
 		<key>selectedTab</key>
 		<string>log</string>
 	</dict>
diff --git a/Objects.scptd/Contents/Resources/Objects.sdef b/Objects.scptd/Contents/Resources/Objects.sdef
@@ -11,7 +11,7 @@
 			<documentation>
 				<html><![CDATA[
 
-<p>Unlike AppleScript records, which are predefined groups of properties whose values are identified by keyword or identifier, dictionary objects are dynamic collections of key-value pairs that can be added and removed at any time. Dictionary keys are typically text values, though numbers, dates, and type and constant symbols can also be used.</p>
+<p>Unlike AppleScript records, which are predefined groups of properties whose values are identified by keyword or identifier, dictionary objects are dynamic collections of key-value pairs that can be added and removed at any time. Dictionary keys can be text, numbers, dates, and/or type and constant symbols.</p>
 
 
 <h3>Examples</h3>
@@ -55,31 +55,31 @@ log obj's getItem("banana") -- Error -1728: "Item not found."</code></pre>
 <dt><code>containsItem(<var>theKey</var>)</code></dt>
 <dd><p>Does the collection contain a key-value pair with the specified key?</p>
 <ul>
-	<li><var>theKey</var> : <tt>text</tt></li>
+	<li><var>theKey</var> : <tt>text, number, date, type or constant</tt></li>
 	<li>Result: <tt>boolean</tt></li>
 </ul>
 </dd>
 
 <dt><code>addItem(<var>theKey</var>, <var>theValue</var>)</code></dt>
 <dd><p>Add a key-value pair to the collection</p>
 <ul>
-	<li><var>theKey</var> : <tt>text</tt></li>
+	<li><var>theKey</var> : <tt>text, number, date, type or constant</tt></li>
 	<li><var>theValue</var> : <tt>anything</tt></li>
 </ul>
 </dd>
 
 <dt><code>removeItem(<var>theKey</var>)</code></dt>
 <dd><p>Remove a key-value pair from the collection</p>
 <ul>
-	<li><var>theKey</var> : <tt>text</tt></li>
+	<li><var>theKey</var> : <tt>text, number, date, type or constant</tt></li>
 	<li>Result: <tt>anything</tt> – the removed value</li>
 </ul>
 </dd>
 
 <dt><code>getItem(<var>theKey</var>)</code></dt>
 <dd><p>Get the value for the given key from the collection</p>
 <ul>
-	<li><var>theKey</var> : <tt>text</tt></li>
+	<li><var>theKey</var> : <tt>text, number, date, type or constant</tt></li>
 	<li>Result: <tt>anything</tt> – the removed value</li>
 </ul>
 </dd>
diff --git a/Objects.scptd/Contents/Resources/Scripts/main.scpt b/Objects.scptd/Contents/Resources/Scripts/main.scpt
diff --git a/Objects.scptd/Contents/Resources/description.rtfd/TXT.rtf b/Objects.scptd/Contents/Resources/description.rtfd/TXT.rtf
@@ -1,4 +1,4 @@
-{\rtf1\ansi\ansicpg1252\cocoartf1404\cocoasubrtf410
+{\rtf1\ansi\ansicpg1252\cocoartf1404\cocoasubrtf460
 {\fonttbl}
 {\colortbl;\red255\green255\blue255;}
 }
diff --git a/TODOs.txt b/TODOs.txt
@@ -20,6 +20,8 @@ File
 ----------------------------------------------------------------------
 
 
+- add support for enumeration type in `parse command line arguments`, where valueType is a list of allowed text values, e.g. {"yes", "no", "maybe"}; allowed chars would be same as for long option names (Q. should it be case sensitive?)
+
 - Standard Additions' `read` and `write` commands don't always provide good explanatory error messages (e.g. passing wrong `as` parameter just gives 'Parameter error.' -50); Cocoa error messages often aren't very helpful either. Not sure there's anything can be done about this.
 
 - is there any benefit to adding `with UTF8 byte order mark` option to `write to file`? (NSString automatically adds UTF16/32 BOMs, but doesn't add UTF8 BOM for compatibility's sake; however, users might want to add UTF8 BOM to improve portability of files they intend to distribute)
@@ -144,7 +146,22 @@ Text
 
 
 ----------------------------------------------------------------------
-Other libraries
+Web
+----------------------------------------------------------------------
+
+
+- in `send HTTP request`:
+
+	-how to support authentication, e.g. tie into keychain? (might be best to leave that for now)
+
+	- requestBodyData/responseBodyType could also be file object/`file`, in which case upload/download tasks could be used (Q. will NSSession supply Content-Length automatically when a file is given? also, will it supply Content-Type automatically, or is there a way to get file's MIME type via Cocoa APIs?)
+
+	- if responseBodyType is `text` and requestHeaders doesn't include "Accept*" headers, add appropriate content negotiation header (e.g. "Accept: text/*") automatically? (what about common application/… headers, e.g. application/json, application/xml? TBH, it'd be a shot in the dark; probably best to leave it entirely to user)
+
+
+
+----------------------------------------------------------------------
+Additional libraries
 ----------------------------------------------------------------------
 
 
@@ -158,3 +175,16 @@ Other libraries
 
 
 
+----------------------------------------------------------------------
+Other issues
+----------------------------------------------------------------------
+
+
+- Should (and can?) ALL ObjC class, method, enum, etc names always be enclosed in pipes? e.g. The File library was accidentally recompiled and resaved after AS converted 'NSURL' identifiers to 'nsurl', causing handlers that used it to break as ASOC, unlike AS, is case-sensitive. 
+
+	Normalizing identifier case in not just current script but all imported scripts too is a fundamental AS flaw that will continue to break users' ASOC code until fixed at source, but these libraries need to be as robust as possible, even if that means crudding up the ASOC parts with pipes. 
+	
+	The big annoyance is that unless identical names but with different case are also defined without pipes, AS will remove the pipes from names that do have them on compilation, whereupon the library code is right back where it started, at risk of breaking in future use.
+
+
+
diff --git a/Web.scptd/Contents/Info.plist b/Web.scptd/Contents/Info.plist
@@ -15,17 +15,17 @@
 		<key>bundleDividerCollapsed</key>
 		<false/>
 		<key>bundlePositionOfDivider</key>
-		<real>622</real>
+		<real>886</real>
 		<key>dividerCollapsed</key>
 		<false/>
 		<key>eventLogLevel</key>
 		<integer>2</integer>
 		<key>name</key>
 		<string>ScriptWindowState</string>
 		<key>positionOfDivider</key>
-		<real>522</real>
+		<real>802</real>
 		<key>savedFrame</key>
-		<string>41 33 871 744 0 0 1280 777 </string>
+		<string>217 33 1135 1024 0 0 1920 1057 </string>
 		<key>selectedTab</key>
 		<string>result</string>
 	</dict>
diff --git a/Web.scptd/Contents/Resources/Scripts/main.scpt b/Web.scptd/Contents/Resources/Scripts/main.scpt
diff --git a/Web.scptd/Contents/Resources/Web.sdef b/Web.scptd/Contents/Resources/Web.sdef
@@ -54,28 +54,28 @@
 		</record-type>
 		
 		
-		<command name="escape URL characters" code="Web:EscU" description="Replace “non-safe” characters in a text value with the corresponding “%XX” escapes suitable for use in a URL">
+		<command name="encode URL characters" code="Web:EscU" description="Replace “non-safe” characters in a text value with the corresponding “%XX” escapes suitable for use in a URL">
 			<direct-parameter type="text"/>
 			<parameter name="preserving" code="Safe" type="text" description="any additional ASCII characters that should not be escaped (default: &quot;&quot;)"/>
 			<result type="text"/>
 			<documentation>
 				<html><![CDATA[
 <p>By default, this converts all characters except <code>A-Za-z0-9_.-</code> to UTF8-based <code>%<var>XX</var></code> escape codes. For example, to escape a resource path, preserving path separators:</p>
 
-<pre><code>escape URL characters "/foo bar/ø.txt" preserving "/" → "/foo%20bar/%C3%B8.txt"</code></pre>
+<pre><code>encode URL characters "/foo bar/ø.txt" preserving "/" → "/foo%20bar/%C3%B8.txt"</code></pre>
 				]]></html>
 			</documentation>
 		</command>
 		
 		
-		<command name="unescape URL characters" code="Web:UneU" description="Replace “%XX” escapes in a text value with the corresponding characters">
+		<command name="decode URL characters" code="Web:UneU" description="Replace “%XX” escapes in a text value with the corresponding characters">
 			<direct-parameter type="text"/>
 			<result type="text"/>
 			<documentation>
 				<html><![CDATA[
 <p>All UTF8-based <code>%<var>XX</var></code> escape codes will be automatically replaced with the corresponding characters. If an escape sequence does not represent a valid UTF8 codepoint, an error is raised instead.</p>
 
-<pre><code></code></pre>
+<pre><code>decode URL characters "/foo%20bar/%C3%B8.txt" → "/foo bar/ø.txt"</code></pre>
 				]]></html>
 			</documentation>
 		</command>
@@ -111,18 +111,30 @@
 	
 	<suite name="Convert Data" code="****">
 		
-		<command name="parse JSON" code="Web:PJSN" description="Parse JSON text as an AppleScript value">
+		<command name="decode Base64" code="Web:PB64" description="Convert text from Base64 encoding">
+			<direct-parameter type="text"/>
+			<result type="text"/>
+		</command>
+		
+		<command name="encode Base64" code="Web:FB64" description="Convert text to Base64 encoding">
+			<direct-parameter type="text"/>
+			<result type="text"/>
+		</command>
+		
+		<command name="decode JSON" code="Web:PJSN" description="Convert JSON text to an AppleScript value">
 			<direct-parameter type="text"/>
 			<parameter name="fragments allowed" code="Frag" type="boolean" optional="yes" description="(default: false)"/>
 			<result type="any"/>
 		</command>
 		
-		<command name="format JSON" code="Web:FJSN" description="Format an AppleScript value as JSON text">
+		<command name="encode JSON" code="Web:FJSN" description="Convert an AppleScript value to JSON text">
 			<direct-parameter type="any"/>
 			<parameter name="extra white space" code="EWSp" type="boolean" optional="yes" description="(default: false)"/>
 			<result type="text"/>
 		</command>
 		
+		<!-- TO DO: what else? e.g. HTML entitites? -->
+		
 	</suite>
 	
 	
@@ -162,6 +174,10 @@
 				<html><![CDATA[
 <pre><code>{ headerName:<var>text</var>,
   headerValue:<var>text</var> }</code></pre>
+
+<p>For example:</p>
+
+<pre><code>{headerName:"Content-Type", headerValue:"application/json; charset=utf-8"}</code></pre>
 				]]></html>
 			</documentation>
 		</record-type>
@@ -178,9 +194,16 @@
 		</record-type>
 		
 			
-		<command name="describe HTTP status code" code="Web:DStC" description="Get a short description of the given HTTP status code (e.g. 404 → “not found”)">
+		<command name="HTTP status name" code="Web:DStC" description="Get a short description of the given HTTP status code">
 			<direct-parameter type="integer"/>
 			<result type="text"/>
+			<documentation>
+				<html><![CDATA[
+<p>For example:</p>
+
+<pre><code>HTTP status name 404 → “not found”</code></pre>
+				]]></html>
+			</documentation>
 		</command>
 		
 	</suite>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{\rtf1\ansi\ansicpg1252\cocoartf1404\cocoasubrtf410`
	`1`	`+{\rtf1\ansi\ansicpg1252\cocoartf1404\cocoasubrtf460`
`2`	`2`	`{\fonttbl}`
`3`	`3`	`{\colortbl;\red255\green255\blue255;}`
`4`	`4`	`}`