panini 1.0.0 → 1.1.0

data/Gemfile

@@ -1,13 +1,8 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.0"
   gem "jeweler", "~> 1.6.0"
   gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -1,14 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
     git (1.2.5)
-    jeweler (1.6.0)
-      bundler (~> 1.0.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
-    rcov (0.9.9)
+    rake (0.9.2)
+    rcov (0.9.10)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -22,7 +22,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.0)
   jeweler (~> 1.6.0)
   rcov
   rspec (~> 2.3.0)

data/README.rdoc

@@ -57,11 +57,24 @@ Here's how the grammar from above is defined:
 === Derivators
 
 Derivators are objects that take a Panini::Grammar and then apply the rules to generate a sentence.  Creating the sentences
-from the grammar can be tricky, and certain derivation strategies may be better for some grammars.
-Currently, the main derivator is the Panini::DerivationStrategy::RandomDampened derivator.
+from the grammar can be tricky, and certain derivation strategies may be better for some grammars.  There are currently two main derivators.
+
+==== Panini::DerivationStrategy::RandomDampened
+
+This strategy creates random sentences given a grammar.  It employs a dampening factor to keep the computation of the sentence from blowing up.
+
+  derivator = Panini::DerivationStrategy::RandomDampened.new(grammar)
+
+This will return a different sentence each time it is called.  It may (and probably will) return the same sentence multiple times.
+
+==== Panini::DerivationStrategy::Exhaustive
+
+This strategy is used to exhaustively create all of the sentences that may be created by a grammar.
 
   derivator = Panini::DerivationStrategy::RandomDampened.new(grammar)
 
+This will return a new sentence with each call.  If there are no additional sentences to be created it will return nil.  The same sentence may be returned multiple times if the grammar can derive the sentence in multiple ways.
+
 === Generating a Sentence
 
 To generate a sentence, call the derivator's sentence method like thus:
@@ -119,6 +132,9 @@ In this example, we create a grammar that generates mathematical expressions.
   end
 
 == Contributing to panini
+
+Contributions to this gem are appreciated!
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -133,9 +149,10 @@ In this example, we create a grammar that generates mathematical expressions.
 * Detect invalid grammars
 * Weighted productions.
 * Arbitrary start symbol.
-* Support Enumerator?
-* DSL?
+* Support Enumerator!
+* DSL or string based grammar definitions
 * Purdom Derivator?
+* Actions
 
 === Examples
 * Natural language

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/derivation_strategy/exhaustive.rb

@@ -0,0 +1,82 @@
+class Array
+
+  def top
+    self.last
+  end
+
+  def has_nonterminals?
+    self.any? do |term|
+      term.class == Panini::Nonterminal
+    end
+  end
+
+end
+
+
+module Panini
+  module DerivationStrategy
+
+    class Exhaustive < Base
+
+      def initialize(grammar)
+        super(grammar)
+        @in_progress_work = [].push([@grammar.start])
+      end
+
+      # Generates a sentence. 
+      def sentence
+        unless @in_progress_work.empty?
+          while @in_progress_work.top.has_nonterminals?
+            generate_work(@in_progress_work.pop)
+          end
+          @in_progress_work.pop
+        end
+      end
+
+      def generate_work(derived_sentence)
+
+        # Find the leftmost nonterminal.
+        i = derived_sentence.index do |term|
+          term.class == Nonterminal
+        end
+        nonterminal = derived_sentence[i]
+
+        # Substitute in each production for the nonterminal.  Do it
+        # in reverse because it causes the results to happen in a more
+        # intuitive order.
+        nonterminal.productions.reverse.each do |production|
+          j = 0
+          newly_derived_sentence = derived_sentence.flat_map do |term|
+            if (i == j)
+              j += 1
+              production
+            else
+              j += 1
+              term
+            end
+          end
+          @in_progress_work.push(newly_derived_sentence)
+        end
+
+      end
+      private :generate_work
+
+      # 
+      # def substitution_pass(derived_sentence)
+      #   substituted = false
+      #   derived_sentence = derived_sentence.flat_map do |term|
+      #     if !substituted && (term.class == Nonterminal)
+      #       substituted = true
+      #       @production_proxies[term].production
+      #     else
+      #       term
+      #     end
+      #   end
+      #   return derived_sentence, substituted
+      # end
+      # private :substitution_pass
+
+    end
+
+  end
+end

data/lib/panini.rb

@@ -3,4 +3,5 @@ require "hash"
 require "nonterminal"
 require "derivation_strategy/base"
 require "derivation_strategy/leftmost"
+require "derivation_strategy/exhaustive"
 require "derivation_strategy/random_dampened"

data/panini.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{panini}
-  s.version = "1.0.0"
+  s.name = "panini"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mjbellantoni"]
-  s.date = %q{2011-05-16}
-  s.description = %q{Panini allows you to generate sentences from a context-free grammar, also known as a CFG.}
-  s.email = %q{mjbellantoni@yahoo.com}
+  s.date = "2011-09-13"
+  s.description = "Panini allows you to generate sentences from a context-free grammar, also known as a CFG."
+  s.email = "mjbellantoni@yahoo.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "examples/arithmetic_expression.rb",
     "lib/derivation_strategy/base.rb",
+    "lib/derivation_strategy/exhaustive.rb",
     "lib/derivation_strategy/leftmost.rb",
     "lib/derivation_strategy/random_dampened.rb",
     "lib/grammar.rb",
@@ -35,6 +36,7 @@ Gem::Specification.new do |s|
     "lib/panini.rb",
     "panini.gemspec",
     "spec/derivation_strategy/dampened_probability_production_choice_proxy_spec.rb",
+    "spec/derivation_strategy/exhaustive_spec.rb",
     "spec/derivation_strategy/leftmost_spec.rb",
     "spec/derivation_strategy/random_dampened_spec.rb",
     "spec/grammar_spec.rb",
@@ -42,30 +44,29 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
     "spec/support/basic_derivation_strategy_shared_example.rb"
   ]
-  s.homepage = %q{http://github.com/mjbellantoni/panini}
+  s.homepage = "http://github.com/mjbellantoni/panini"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Create sentences from a context-free grammar (CFG)}
+  s.rubygems_version = "1.8.10"
+  s.summary = "Create sentences from a context-free grammar (CFG)"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end

data/spec/derivation_strategy/exhaustive_spec.rb

@@ -0,0 +1,119 @@
+require "spec_helper"
+
+
+describe Panini::DerivationStrategy::Exhaustive do
+  it_behaves_like "basic derivation strategy"  
+end
+
+
+describe "Grammar with the production S -> AAB, A -> 'a' | 'x', B -> 'b'" do
+
+  before (:each) do
+    @g = Panini::Grammar.new
+
+    @n_s = @g.add_nonterminal
+    @n_a = @g.add_nonterminal
+    @n_b = @g.add_nonterminal
+
+    @n_s.add_production([@n_a, @n_a, @n_b])
+    @n_a.add_production(['a'])
+    @n_a.add_production(['x'])
+    @n_b.add_production(['b'])
+  end
+
+  it "generates the sentence ['a', 'a', 'b'] first" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence.should == ['a', 'a', 'b']
+  end
+
+  it "generates the sentence ['a', 'x', 'b'] next" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence
+    d.sentence.should == ['a', 'x', 'b']
+  end
+
+  it "generates the sentence ['x', 'a', 'b'] next" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence
+    d.sentence
+    d.sentence.should == ['x', 'a', 'b']
+  end
+
+  it "generates the sentence ['x', 'x', 'b'] next" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence
+    d.sentence
+    d.sentence
+    d.sentence.should == ['x', 'x', 'b']
+  end
+
+  it "generates nil next" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence
+    d.sentence
+    d.sentence
+    d.sentence
+    d.sentence.should be_nil
+  end
+
+end
+
+
+describe "Grammar with the production S -> 'a' | 'b'" do
+
+  before (:each) do
+    @g = Panini::Grammar.new
+    @n = @g.add_nonterminal
+    @n.add_production(['a'])
+    @n.add_production(['b'])
+  end
+
+  it "generates the sentence ['a']" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence.should == ['a']
+  end
+
+  it "generates the sentence ['b']" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence
+    d.sentence.should == ['b']
+  end
+
+end
+
+
+describe "Grammar with the production S -> xAyBz, A -> 'a' | 'aa', B -> 'b' | 'bb' " do
+
+  before (:each) do
+    @g = Panini::Grammar.new
+
+    @n_s = @g.add_nonterminal
+    @n_a = @g.add_nonterminal
+    @n_b = @g.add_nonterminal
+
+    @n_s.add_production(['x', @n_a, 'y', @n_b, 'z'])
+    @n_a.add_production(['a'])
+    @n_a.add_production(['aa'])
+    @n_b.add_production(['b'])
+    @n_b.add_production(['bb'])
+  end
+
+  it "generates the sentence ['x', 'a', 'y', 'b', 'z'] first" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence.should == ['x', 'a', 'y', 'b', 'z']
+  end
+
+  it "generates the sentence ['x', 'a', 'y', 'bb', 'z'] next" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence.should
+    d.sentence.should == ['x', 'a', 'y', 'bb', 'z']
+  end
+
+  it "generates the sentence ['x', 'aa', 'y', 'b', 'z'] next" do 
+    d = Panini::DerivationStrategy::Exhaustive.new(@g)
+    d.sentence.should
+    d.sentence.should
+    d.sentence.should == ['x', 'aa', 'y', 'b', 'z']
+  end
+
+end

data/spec/derivation_strategy/leftmost_spec.rb

@@ -71,20 +71,3 @@ describe "Grammar with the production S -> S | 'a' | 'b'" do
   end
 
 end
-
-
-describe "with the production S -> 'a' | 'b'" do
-
-  before (:each) do
-    @g = Panini::Grammar.new
-    @n = @g.add_nonterminal
-    @n.add_production(['a'])
-    @n.add_production(['b'])
-  end
-
-  it "generates the sentence ['a']" do 
-    d = Panini::DerivationStrategy::Leftmost.new(@g)
-    d.sentence.should == ['a']
-  end
-
-end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: panini
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - mjbellantoni
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -04:00
-default_executable: 
+date: 2011-09-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -24,10 +19,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 0
         version: 2.3.0
   type: :development
   prerelease: false
@@ -39,11 +30,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+        version: "1.0"
   type: :development
   prerelease: false
   version_requirements: *id002
@@ -54,10 +41,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 0
         version: 1.6.0
   type: :development
   prerelease: false
@@ -69,8 +52,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -95,6 +76,7 @@ files:
 - VERSION
 - examples/arithmetic_expression.rb
 - lib/derivation_strategy/base.rb
+- lib/derivation_strategy/exhaustive.rb
 - lib/derivation_strategy/leftmost.rb
 - lib/derivation_strategy/random_dampened.rb
 - lib/grammar.rb
@@ -103,13 +85,13 @@ files:
 - lib/panini.rb
 - panini.gemspec
 - spec/derivation_strategy/dampened_probability_production_choice_proxy_spec.rb
+- spec/derivation_strategy/exhaustive_spec.rb
 - spec/derivation_strategy/leftmost_spec.rb
 - spec/derivation_strategy/random_dampened_spec.rb
 - spec/grammar_spec.rb
 - spec/nonterminal_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_derivation_strategy_shared_example.rb
-has_rdoc: true
 homepage: http://github.com/mjbellantoni/panini
 licenses: 
 - MIT
@@ -123,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 286269899475831067
+      hash: -1665720431960213425
       segments: 
       - 0
       version: "0"
@@ -132,13 +114,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Create sentences from a context-free grammar (CFG)