sequitur 0.0.10 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzQ3ZTE3YTkyZTkyMmE3MzYzZmY1YTA0ZTdhZGExZDE5NjM1NzkxOQ==
+    OGM4MWZiN2YzOTRmODhhNDlkNGIzMGRiOWYzZjU3MDY5ODc2YWUwMg==
   data.tar.gz: !binary |-
-    ZDMxZjI4ODQzNWFmOTU2ZmI1NjI0ZmJmNmM2Yjc4NjFlYmI2ZGNjZQ==
+    ZGJmYzVjMzlkOTE0ZGRhZGI3ZWRjY2IyMDk3ZGY3ZDY1YjIyY2YyNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjVhYmFkOTgwYjVhNmFmNmNhYzRmNzFiZjYwNDI1ZmNiY2M4MzdlYTkxZmY2
-    MTA1NDI4NWQ4N2IxMTkxNTU5NWNiZTk4ZDYxYzcyODQ4YjExYWU4MzJhZmI5
-    OTM0YTBiNDUxNzNkZDQwNTVmY2Y5NzhlYTc5MjJkNGYxMjRlYWU=
+    Nzk1ZDRmNjBkN2FmODQ4Yjk5ODNiYTk3NDA1YTkxYmZlYjMyOGI0MDhkZTM5
+    NTg1ZWQyOGIxYzc2NjE4ODg0ODY1MDJiMzJhNDBmNGJlMjdiNzAwMTI3ZmZl
+    MDkzMGFjYWNhNTU4ZWUwYTBjYjdlMjJjNjc2MmY5ZTk5MTUzNTQ=
   data.tar.gz: !binary |-
-    YWQ3MDZkZWJhN2NjZTZkMzhmYjZiMGMwYjk5MjIyNzg2YWMzMGIwMjU1ZTY5
-    MzkwOGJiNDI2ZjRhZjk2YjZhN2Q2NTJiYzA3OGMxNDNiMmNmYjBjNWM1MDZm
-    M2FjYzVlY2M2MWM1Y2I1Y2UyMzgxMjBiZWNiZWI4NzFlOGRjOWM=
+    MWQ2OGU3OWIyMzQ5MWVkM2IxZGFhYzhmNDM5MGRkMzA5MjlhNzUxYTViYWMz
+    MzIzY2MxYjk1OTBmMTNkNmM4NDM0NWI4YzJlZDk5YjU2ZjU4YmM2ZWYzMjkx
+    MmNkYWE5MjU3NmI3MTE1OTIwYWZmOWI1ODRlMmQ4ZmZjNjkwY2E=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.0.11 / 2014-08-24
+* [FIX] `SequiturGrammar#check_unicity`: an exception was raised when it shouldn't. Added example in spec file.
+* [CHANGE] `sequitur.rb` : Added the convenience Sequitur::build_from method.
+
 ### 0.0.10 / 2014-08-24
 * [CHANGE] `README.md`: Added hyperlinks about Sequitur algorithm.
 

data/README.md

@@ -15,7 +15,29 @@ Sequitur is an algorithm that generates a set of rules representing a sequence o
 It detects repeated token patterns and can represent them in a compact way.
 
 
-### TODO: Add documentation ###
+## Synopsis  
+
+```ruby  
+
+    require 'sequitur' # Load the Sequitur library
+
+    input_sequence =  'abcabdab'
+
+    # The SEQUITUR algorithm will detect the repeated 'ab' pattern
+    # and will generate a context-free grammar that represents the input string
+    grammar = Sequitur.build_from(input_sequence)
+
+    # Display the grammar rules
+    # Each rule is displayed with the format:
+    # rule_id : a_sequence_grammar_symbols
+    # Where: 
+    # - rule_id is the object id of a rule (in decimal)
+    # - a grammar symbol is either a terminal symbol 
+    # (i.e. a character from the input) or the id of a production
+    puts grammar.to_string
+```
+
+### TODO: Add more documentation ###
 
 
 Copyright

data/lib/sequitur.rb

@@ -5,4 +5,24 @@
 require_relative './sequitur/constants'
 require_relative './sequitur/sequitur_grammar'
 
+
+module Sequitur
+
+  # Convenience method. Builds a Sequitur-generated grammar based
+  # on the sequence of input tokens
+  # @param tokens [StringOrEnumerator] The input sequence of input tokens.
+  # Can be a sequence of characters (i.e. a String) or an Enumerator
+  # Tokens returned by enumerator should respond to the :hash message.
+  # Returns a SequiturGrammar instance.
+  def self.build_from(tokens)
+    input_sequence = case tokens
+      when String then tokens.chars
+      when Enumerator then tokens
+      else tokens.to_enum
+    end
+    
+    return SequiturGrammar.new(input_sequence)
+  end
+end # module
+
 # End of file

data/lib/sequitur/constants.rb

@@ -3,7 +3,7 @@
 
 module Sequitur # Module used as a namespace
   # The version number of the gem.
-  Version = '0.0.10'
+  Version = '0.0.11'
 
   # Brief description of the gem.
   Description = 'Ruby implementation of the Sequitur algorithm'

data/lib/sequitur/sequitur_grammar.rb

@@ -41,7 +41,7 @@ class SequiturGrammar < DynamicGrammar
           msg << "\nOnce in production #{colliding.production_id}"
           msg << "\nSecond in production #{a_prod.object_id}"
           msg << "\n#{to_string}"
-          fail StandardError, msg
+          fail StandardError, msg unless colliding.production_id == a_prod.object_id
         else
           all_digrams[a_digram.key] = a_digram
         end

data/spec/sequitur/sequitur_grammar_spec.rb

@@ -74,6 +74,13 @@ describe SequiturGrammar do
       expect(p_a.rhs).to eq([:a, :b, :c])
       expect(instance.root.rhs).to eq([p_a, p_a])
     end
+    
+    it 'should cope with a pattern that caused an exception' do
+      input = 'aaac'  # This sequence raised an exception
+
+      # Creation
+      expect {SequiturGrammar.new(input.chars)}.not_to raise_error
+    end
 
 
     it 'should cope with the example from presentation' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequitur
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake