conlang 0.2.0 → 0.2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9c221e8eefb643ff2b4ff6808d7758df343a1f0
-  data.tar.gz: 61d9f3daab090cfbb598a66a19750ac10a5d805a
+  metadata.gz: a2e2972b439eaeeff3a865a94f862ca266bf57c2
+  data.tar.gz: c1b94be6c8d7dbee38a2b55be794882f653f42f1
 SHA512:
-  metadata.gz: 1a9337ab8f9e2ed17cd1fb83adc6886668ac9b0e7b01e9e439829531a8c1f195b29a22a54f788863fdb89bafc421e7d047a13f0f60cede08822cc498348b8b73
-  data.tar.gz: fa2f8cc35e30f01dc2db36cab0958e13e8448ae21d73fb1a3b38e8f2d3b363da89de5052d48a85fe736ed6bc13bdf8ca228cf29fce87cf62f95c2b19bf9be20f
+  metadata.gz: 873f2eb94c953f7a7df75c60f750c66787f2b028c516b19c2158293afc87957663bb0394da6797ee0fe49071f035e86df23cdcf3cf0ffb9f44dc9d1be3457931
+  data.tar.gz: 49fa67c205f1468b636bca6bf9cf0cfba42a89340ed04c85a7108b7985474c67fdb8befd5fbfebf1c9ce72ed656a7119f4e83ea0e68067a0705ebde73ce6f012

data/CHANGELOG.md

@@ -6,8 +6,12 @@ TODO
 
 Implemented features
 ====================
- * Maybe(A) operator (no weight is requiered,
+ * `Maybe(A)` operator (no weight is requiered,
    default probability is 50)
- * Or(A, b) operator (no wight is requiered,
+ * `Or(A, b)` operator (no wight is requiered,
    default probability is 50)
- * Published as a Ruby gem
+ * Released as a Ruby gem
+ * An executable in `\bin` has been included.
+   See [README.md](README.md) to see
+   documentation about how to use this gem
+   as a command line utility.

data/README.md

@@ -17,16 +17,24 @@ described language.
 
 Instructions
 ------------
-Usage:
+Usage as **command line executable**:
+
+	conlang <words count> '<LANG file>'
+
+This command produces an `output-<name>.txt`
+file that includes a list of the generated words,
+separated by newlines.
+
+Usage as **gem**:
 
 	require 'conlang'
 
 	# Path to LANG file, as constructor.
-	 x = WordGenerator.new("tokipona.lang")
+	x = WordGenerator.new("tokipona.lang")
 
 	# Print ten generated words as
 	# an array of strings.
-	 p x.get_words(10)
+	p x.get_words(10)
 
 
 There are `*.lang` files as examples at `lang-examples` 

data/bin/conlang

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+# This script allows the 'conlang' gem
+# to be used as a command line utility.
+
+# Instructions for usage
+USAGE = "   Usage:\n     conlang <words count> '<LANG file>'\n\n" +
+        "   See documentation for more information in README at\n" +
+        "     https://github.com/fluorine/ConlangWordGenerator"
+
+# If incorrect quantity of arguments
+if ARGV.length != 2 && ARGV[0] !~ /d+/ && ARGV[1] !~ /\.lang$/
+  p "argv"
+  puts USAGE
+  exit
+end
+
+# Import gem
+require 'conlang'
+
+# Use conlang gem as an utility and
+# show instructions if an error occurs
+begin
+  # Parse arguments
+  words_qty = ARGV[0].to_i
+  filename  = ARGV[1].split(".")[0]
+
+  # Generate words
+  generator = WordGenerator.new(filename + ".lang")
+  words     = generator.get_words(words_qty)
+
+  # Produce output file
+  IO.write(filename + "-output.txt", words.join("\n"))
+  puts "  '#{filename + "-output.txt"}' file has been produced."
+rescue
+  puts USAGE
+end

data/lib/conlang/version.rb

@@ -1,3 +1,3 @@
 module ConlangWordGenerator
-  VERSION = '0.2.0'
+  VERSION = '0.2.1.1'
 end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: conlang
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1.1
 platform: ruby
 authors:
 - Joseph
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies: []
 description: 'This gem takes constructed grammar and phonemes from a LANG file to
   generate random words. You can learn how to create LANG files, or explore some sample
   files, at this project''s source repository on Github: https://github.com/fluorine/ConlangWordGenerator'
 email: fluorine@github.com
-executables: []
+executables:
+- conlang
 extensions: []
 extra_rdoc_files: []
 files:
@@ -23,10 +24,10 @@ files:
 - lib/conlang/symbolset.rb
 - lib/conlang/version.rb
 - lib/conlang/wordgenerator.rb
+- bin/conlang
 - CHANGELOG.md
 - LANG_FILES_DOC.md
 - README.md
-- TODO.md
 - LICENSE.txt
 - NOTICE.txt
 - test/test_file_maybe.lang
@@ -37,8 +38,8 @@ licenses:
 - Apache
 metadata: {}
 post_install_message: |2-
-    Go to https://github.com/fluorine/ConlangWordGenerator to learn
-    how to create LANG files to generate words for constructed languages.
+     Go to https://github.com/fluorine/ConlangWordGenerator to learn
+     how to create LANG files to generate words for constructed languages.
 rdoc_options: []
 require_paths:
 - lib

data/TODO.md

@@ -1,12 +0,0 @@
-TODO
-====
- * Support of UTF-8 symbols
- * Grammatical exceptions, or replacements
- * More operators
-
-Implemented features
-====================
- * Maybe(A) operator (no weight is requiered,
-   default probability is 50)
- * Or(A, b) operator (no wight is requiered,
-   default probability is 50)