conlang 0.2.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2e2972b439eaeeff3a865a94f862ca266bf57c2
-  data.tar.gz: c1b94be6c8d7dbee38a2b55be794882f653f42f1
+  metadata.gz: 84b2be900d933ecb7e56837534a993f5ad6c4219
+  data.tar.gz: e99c3ede33eb2a80daa0fa9a7d9d6b16594d9d7a
 SHA512:
-  metadata.gz: 873f2eb94c953f7a7df75c60f750c66787f2b028c516b19c2158293afc87957663bb0394da6797ee0fe49071f035e86df23cdcf3cf0ffb9f44dc9d1be3457931
-  data.tar.gz: 49fa67c205f1468b636bca6bf9cf0cfba42a89340ed04c85a7108b7985474c67fdb8befd5fbfebf1c9ce72ed656a7119f4e83ea0e68067a0705ebde73ce6f012
+  metadata.gz: c01f9db7fc189ea4596934fa6b3dc4b6628340f6f6363b024226c26591df561c5558291bb8e256011d17e2b52e6511355105b4f7a8c12edb6c17594c1424c8ba
+  data.tar.gz: fdd3340b5d0de13370d2a86080543246d0aa409524c393ff49b9c5d61544543e0497243a13c6ba349bc4e7f9be8aaf173757c4d7c131abaabbfb5ea80c78cffb

data/CHANGELOG.md

@@ -14,4 +14,8 @@ Implemented features
  * 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.
+   as a command line utility.
+ * New release (v0.3.0)
+ * Better and more specific Exceptions
+ * More tests, Rake file
+ 

data/README.md

@@ -1,4 +1,4 @@
-ConlangWordGenerator, 0.2.0 beta.
+ConlangWordGenerator, v0.3.0
 =================================
 **Now it's a gem!**
 
@@ -7,8 +7,8 @@ Description
 This gem allows the user to generate words for
 constructed languages, given a LANG file that
 describes the language. It can also be useful
-for linguistics to study and generate words from
-a given language.
+for linguistics to study and generate valid words
+from a descripted language.
 
 The `*.lang` file must include sets of phonemes with 
 their individual probability weight, and a grammatical
@@ -17,7 +17,7 @@ described language.
 
 Instructions
 ------------
-Usage as **command line executable**:
+Usage as a **command line executable**:
 
 	conlang <words count> '<LANG file>'
 
@@ -25,7 +25,7 @@ This command produces an `output-<name>.txt`
 file that includes a list of the generated words,
 separated by newlines.
 
-Usage as **gem**:
+Usage as a **gem**:
 
 	require 'conlang'
 
@@ -55,3 +55,12 @@ Again, examples at `lang-examples` directory can help you a lot.
 The class `WordGenerator` takes a path to a valid `*.lang`
 file to produce a generator of words, as described previously
 in the **Instructions** section.
+
+Root-level identifiers
+----------------------
+- **WordGenerator** - Main class
+- **ConlangWordGenerator** - Namespace module for the gem
+- Exceptions
+   - **LangFileError** < StandardError, for LANG files
+   - **LangFileIOError** < LangFileError
+   - **LangSyntaxError** < LangFileError

data/bin/conlang

@@ -10,7 +10,6 @@ USAGE = "   Usage:\n     conlang <words count> '<LANG file>'\n\n" +
 
 # If incorrect quantity of arguments
 if ARGV.length != 2 && ARGV[0] !~ /d+/ && ARGV[1] !~ /\.lang$/
-  p "argv"
   puts USAGE
   exit
 end
@@ -23,15 +22,27 @@ require 'conlang'
 begin
   # Parse arguments
   words_qty = ARGV[0].to_i
-  filename  = ARGV[1].split(".")[0]
+  filename  = ARGV[1]
+  name      = filename.split(".")[0]
 
   # Generate words
-  generator = WordGenerator.new(filename + ".lang")
+  generator = WordGenerator.new(filename)
   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
+  IO.write(name + "-output.txt", words.join("\n"))
+  puts "  '#{name}-output.txt' file has been produced."
+  
+rescue LangFileIOError => e
+  puts e.inspect + "\n"
   puts USAGE
+
+rescue LangFileIOError => e
+  puts e.inspect + "\n"
+  puts USAGE
+
+rescue StandardError => e
+  puts e.inspect + "\n"
+  puts USAGE
+  
 end

data/lib/conlang.rb

@@ -1,4 +1,4 @@
-#encoding:utf-8
+require 'conlang/errors'
 require 'conlang/operators'
 require 'conlang/symbolset'
 require 'conlang/wordgenerator'

data/lib/conlang/errors.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+class LangFileError < StandardError
+  def initialize(msg)
+    super msg
+  end
+end
+
+# If LANG file doesn't exists
+# or the loading fails
+class LangFileIOError < LangFileError
+end
+
+# If syntax error in LANG file 
+class LangSyntaxError < LangFileError
+end

data/lib/conlang/operators.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 # Operators for .lang grammatical expressions.
 #   - maybe(weight, symbolset)
 #       The symbolset may appear or not (empty string),
@@ -21,8 +23,8 @@ module ConlangWordGenerator
   class Or
     def initialize(weight, setA, setB)
       unless weight > 0 and weight < 100
-        raise "Error: Weight for an or() operator " +
-              "must be between 1 and 100 (exclusive)."
+        raise LangSyntaxError, "Weight for an or() operator must " +
+                               "be between 1 and 100 (exclusive)."
       end
 
       @weight = weight
@@ -64,8 +66,8 @@ module ConlangWordGenerator
   class Maybe
     def initialize(weight, set)
       unless weight > 0 and weight < 100
-        raise "Error: Weight for an maybe() operator " +
-              "must be between 1 and 100 (exclusive)."
+        raise LangSyntaxError, "Weight for an maybe() operator " +
+                               "must be between 1 and 100 (exclusive)."
       end
 
       @weight = weight
@@ -95,7 +97,7 @@ module ConlangWordGenerator
     elsif args.length == 3
       Or.new(args[0].to_i, args[1], args[2])
     else
-      raise "Error evaluating an Or() expression."
+      raise LangSyntaxError, "Invalid Or() operator arguments."
     end
   end
 
@@ -105,7 +107,7 @@ module ConlangWordGenerator
     elsif args.length == 2
       Maybe.new(args[0].to_i, args[1])
     else
-      raise "Error evaluating Maybe() expression."
+      raise LangSyntaxError, "Invalid Maybe() operator arguments."
     end
   end
 
@@ -132,6 +134,11 @@ module ConlangWordGenerator
 
     # Evaluate all generated assigments
     # and then the grammatical expression.
-    eval(expr)
+    begin
+      eval(expr)
+    rescue
+      raise LangSyntaxError, "Invalid operators or bindings " +
+                             "in grammatical expression."
+    end
   end
 end

data/lib/conlang/symbolset.rb

@@ -12,7 +12,8 @@ module ConlangWordGenerator
     # Add new symbol with its probability into the set
     def add_pair(symbol, weight)
       unless weight > 0 and weight < 100
-        raise "Weight of symbol '#{symbol}' must be a value between 1 and 99."
+        raise LangSyntaxError, "Weight of symbol '#{symbol}' must be " +
+                               "a value between 1 and 99, inclusive."
       end
 
       # Insert new pair in the sorted array of pairs

data/lib/conlang/version.rb

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

data/lib/conlang/wordgenerator.rb

@@ -1,11 +1,9 @@
 #!/usr/bin/env ruby
 
-#require 'lib/symbolset.rb'
-
 #
 # This Ruby class generates random words using 
 # prabability-weighted symbols, and grammar rules
-# from a given .lang file as input.
+# from a given *.lang file as input.
 # 
 
 class WordGenerator
@@ -13,12 +11,14 @@ class WordGenerator
   def initialize(file)
     # Check file extension.
     unless file.match(/.*\.lang/)
-      raise "Given file, \"#{file}\", is not a .lang file." 
+      raise LangFileIOError,
+            "Given file, \"#{file}\", is not a .lang file." 
     end
 
     # Check if files exist
     unless File.exist?(file)
-      raise "File \"#{file}\" was not found." 
+      raise LangFileIOError,
+            "File \"#{file}\" was not found." 
     end
 
     #   #   #   #   #   #   #   #   #
@@ -75,8 +75,8 @@ class WordGenerator
             # Copying expression
             @full_expression += line.strip
           else
-            raise "Runtime error when evaluating " +
-                  "\"#{@lang_file}\" at line #{lines_count}."
+            raise LangSyntaxError, "Runtime error when evaluating " +
+                                   "\"#{@lang_file}\" at line #{lines_count}."
           end
         end
 
@@ -89,7 +89,8 @@ class WordGenerator
   # This method evaluates the grammatical expression
   # and then generate random words.
   def eval_expression
-    @evaluated_expression = ConlangWordGenerator::run_expression(@full_expression, @bindings)
+    @evaluated_expression =
+       ConlangWordGenerator::run_expression(@full_expression, @bindings)
   end
 
   # This method generates words

data/test/test_symbolset.rb

@@ -0,0 +1,24 @@
+require 'conlang'
+require 'test/unit'
+
+class TestSymbolset < Test::Unit::TestCase
+  def setup
+    @ss = ConlangWordGenerator::SymbolSet.new
+  end
+
+  def test_out_of_weight_upper_range
+    (100...110).each do |n|
+      assert_raise(LangSyntaxError) do
+        @ss.add_pair 'x', n
+      end
+    end
+  end
+
+  def test_out_of_weight_lower_range
+    (-5...1).each do |n|
+      assert_raise(LangSyntaxError) do
+        @ss.add_pair 'x', n
+      end
+    end
+  end
+end

data/test/test_syntax_error.lang

@@ -0,0 +1,18 @@
+# Thest LANG file for MAYBE operators.
+
+symbols for a vowel:
+   a: 50
+   o: 50
+
+########ERROR##########
+maybe(vowel)
+#######################
+
+symbols for any constant:
+   p: 33
+   t: 33
+   k: 33      
+
+expression:
+# Pattern: /^[ptk]*[ao]*$/
+   Maybe(constant) + maybe(10, vowel)

data/test/test_wordgenerator.rb

@@ -2,15 +2,43 @@ require 'conlang'
 require 'test/unit'
 
 class TestWordGenerator < Test::Unit::TestCase
+  #
+  # Test if an Error occurs when opening a file
+  #
+  def test_file_does_not_exist
+    assert_raise(LangFileIOError) do
+      WordGenerator.new(Dir.pwd + "/test/doesnt_exists.lang")
+    end
+  end
+
+  def test_not_lang_file
+    assert_raise(LangFileIOError) do
+      WordGenerator.new(Dir.pwd + "/test/not_lang.gaga")
+    end
+  end
+
+  #
+  # Catch a general error in LANG file's body
+  #
+  def test_lang_syntax_error
+    assert_raise(LangSyntaxError) do
+      WordGenerator.new(Dir.pwd + "/test/test_syntax_error.lang")
+    end
+  end
+
+  #
+  # Test if operators work fine throw
+  # the WordGenerator class.
+  #
   def test_or_operators
-    words = WordGenerator.new("test_file_or.lang").get_words(10)
+    words = WordGenerator.new(Dir.pwd + "/test/test_file_or.lang").get_words(10)
     words.each do |word|
       assert_match(/^[aoptk][ao]$/, word)
     end
   end
 
   def test_maybe_operators
-    words = WordGenerator.new("test_file_maybe.lang").get_words(10)
+    words = WordGenerator.new(Dir.pwd + "/test/test_file_maybe.lang").get_words(10)
     words.each do |word|
       assert_match(/^[ptk]*[ao]*$/, word)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conlang
 version: !ruby/object:Gem::Version
-  version: 0.2.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Joseph
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-20 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
@@ -20,6 +20,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/conlang.rb
+- lib/conlang/errors.rb
 - lib/conlang/operators.rb
 - lib/conlang/symbolset.rb
 - lib/conlang/version.rb
@@ -30,8 +31,11 @@ files:
 - README.md
 - LICENSE.txt
 - NOTICE.txt
+- test/not_lang.gaga
 - test/test_file_maybe.lang
 - test/test_file_or.lang
+- test/test_symbolset.rb
+- test/test_syntax_error.lang
 - test/test_wordgenerator.rb
 homepage: https://github.com/fluorine/ConlangWordGenerator
 licenses: