altprintf 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e5b126835ddd39ea0e84a6af5f43c54dd7016f392b539ed97e08ccaab9841a
-  data.tar.gz: e168cbfef10fcabfdc8ed1f7b29be4ac0674bbc17fed5e06efa7d0e8d068fbc8
+  metadata.gz: 134617d2a0afa2d1fcbcc02b7e83421b625ed740e80a02869d73fd9c32f9bff9
+  data.tar.gz: 2ff6cc05cd95897746fbdbad9a8d1c7c98ec9ad3430ce6dfcb58de5eea4508ce
 SHA512:
-  metadata.gz: 0f27dd11f63071be3acfe161bbb71ff4bd081031892125d83dc7c97b3734c325c23e707ca197dc4890f0f5234c902515b8ee60d25269c4d924470c7c004e41ba
-  data.tar.gz: 752769a18da696a2ea25d413cdb37648e8373eead3bd60bce0a205a973913277e622a508b2ae222b03ea7d89d48b42243edd16212ac893e5f125549d8a9736b9
+  metadata.gz: 1c6fbb933675cdf58684849b252a61da79241bb86c9da851bc01f9abfeac3e7fa1cfc0211753fd6d0701c68085091c739853a1972d7f3f527ea4a6e89293df3c
+  data.tar.gz: 2542ed5e8d4417a9858c11b9fab94e61c2582827ee0976c261bc87e3ea8450a4eae9d3fa1e45d2ec955de0067717e88e9739d4e2fe5f8d09e857c4d2005d941e

data/ext/altprintf/altprintf/altprintf.h

@@ -1,6 +1,6 @@
 #ifndef ALTPRINTF_H_
 #define ALTPRINTF_H_
-#define ALTPRINTF_VERSION "0.3.2"
+#define ALTPRINTF_VERSION "0.3.3"
 
 #include <altprintf/fmt.h>
 #include <altprintf/fmte.h>

data/ext/altprintf/ext.c

@@ -14,8 +14,6 @@
 #include <altprintf/altprintf.h>
 #include <altprintf/log.h>
 
-#define MODNAME "Altprintf"
-
 rb_encoding *enc;
 
 char *rbstocs(VALUE *rbstr)
@@ -209,11 +207,44 @@ VALUE rb_altprintf(long passes, size_t argc, VALUE *argv, VALUE self)
 	return final;
 }
 
+/*
+ * call-seq:
+ *	fmt(format_string [, arguments...]) -> String
+ *
+ * Formats a `format_string` with `arguments`.  `format_string` may be any
+ * vaild altprintf format string .
+ * Additionally, a hash may be specified as the last argument, or as keyword
+ * arguments and the values of the hash may be directly accessed in the format
+ * string using < and >.
+ *
+ * For example:
+ *	fmt("hello %<name>", name: "John") #=> "hello John"
+ *
+ * Note that the keys within <> are always assumed to be symbols, so the
+ * following would not work
+ *	fmt("hello %<name>", { "name" => "John" }) #=> "hello John"
+ */
 VALUE rb_altprintf_single_pass(size_t argc, VALUE *argv, VALUE self)
 {
 	return rb_altprintf(1, argc, argv, self);
 }
 
+
+
+/*
+ * call-seq:
+ *   fmtm(passes, format_string [, arguments...]) -> String
+ *
+ * Same as #fmt, but takes an additional argument, passes, which specifies the
+ * number of passes to go over the format string.
+ *
+ * For example:
+ *	fmtm(0, "%%%%%%%%") #=> "%%%%%%%%"
+ *	fmtm(1, "%%%%%%%%") #=> "%%%%"
+ *	fmtm(2, "%%%%%%%%") #=> "%%"
+ *	fmtm(3, "%%%%%%%%") #=> "%"
+ *	fmtm(4, "%%%%%%%%") #=> ""
+ */
 VALUE rb_altprintf_multi_pass(size_t argc, VALUE *argv, VALUE self)
 {
 	long passes;
@@ -233,10 +264,19 @@ void Init_altprintf()
 	size_t len;
 
 	enc = rb_enc_find("UTF-8");
-	mod = rb_define_module(MODNAME);
+
+	/*
+	 * The base module for *Altprintf*.  For documentation on the syntax of
+	 * the format string, see https://github.com/annacrombie/altprintf
+	 */
+	mod = rb_define_module("Altprintf");
 
 	len = strlen(ALTPRINTF_VERSION);
 	ver = rb_external_str_new_with_enc(ALTPRINTF_VERSION, len, enc);
+
+	/*
+	 * The version of libaltprintf that this extension was compiled against.
+	 */
 	rb_define_const(mod, "LIB_VERSION", ver);
 
 	rb_define_module_function(mod, "fmt", rb_altprintf_single_pass, -1);

data/lib/altprintf/version.rb

@@ -1,3 +1,3 @@
 module Altprintf
-  VERSION ||= "0.3.2"
+  VERSION ||= "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: altprintf
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Stone Tickle