panini 1.0.0

data/spec/derivation_strategy/random_dampened_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+
+describe Panini::DerivationStrategy::RandomDampened do
+  it_behaves_like "basic derivation strategy"  
+end
+
+
+describe Panini::DerivationStrategy::RandomDampened do
+
+  before (:each) do
+    @g = Panini::Grammar.new.tap do |grammar|
+      grammar.add_nonterminal.add_production([])
+    end
+  end
+
+  it "raises an exception if the damping factor is too small" do
+    lambda { described_class.new(@g, 1.0) }.should raise_error(ArgumentError, "The damping factor must be greater than 0.0 and less than 1.0.")
+  end
+
+  it "raises an exception if the damping factor is too large" do
+    lambda { described_class.new(@g, 0.0) }.should raise_error(ArgumentError, "The damping factor must be greater than 0.0 and less than 1.0.")
+  end
+
+end
+
+describe Panini::DerivationStrategy::RandomDampened, "sentence with an arethmetic expression grammar" do
+
+  before(:each) do
+    @grammar = Panini::Grammar.new
+
+    expression = @grammar.add_nonterminal
+    term = @grammar.add_nonterminal
+    factor = @grammar.add_nonterminal
+    identifier = @grammar.add_nonterminal
+    number = @grammar.add_nonterminal
+
+
+    # =============
+    # = Terminals =
+    # =============
+    expression.add_production([term, '+', term])
+    expression.add_production([term, '-', term])
+    expression.add_production([term])
+
+    term.add_production([factor, '*', term])
+    term.add_production([factor, '/', term])
+    term.add_production([factor])
+
+    factor.add_production([identifier])
+    factor.add_production([number])
+    factor.add_production(['(', expression, ')'])
+
+    ('a'..'z').each do |v|
+      identifier.add_production([v])
+    end
+
+    (0..100).each do |n|
+      number.add_production([n])
+    end
+
+    Kernel::stub(:rand).and_return(0.3)
+  end
+
+  context "with very little damping" do
+
+    before(:each) do
+      @deriver = described_class.new(@grammar, 0.999999999999)      
+    end
+
+    it "encounters a stack error" do
+      lambda { @deriver.sentence }.should raise_error(SystemStackError)
+    end
+ 
+  end
+
+  context "with damping" do
+
+    before(:each) do
+      @deriver = described_class.new(@grammar)      
+    end
+
+    it "returns an expected sentence" do
+      @deriver.sentence.should == ["h", "*", "h", "/", "h", "/", "h", "+", "h", "*", "h", "/", "h", "/", "h"]
+    end
+
+  end
+
+
+end

data/spec/grammar_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "Grammar" do
+
+  before (:each) do
+    @g = Panini::Grammar.new
+  end
+
+  it "responds to #add_nonterminal" do
+    @g.should respond_to(:add_nonterminal)
+  end
+
+  it "responds to #nonterminals" do
+    @g.should respond_to(:nonterminals)
+  end
+
+  it "responds to #start" do
+    @g.should respond_to(:start)
+  end
+
+end
+
+
+
+describe "Grammar#add_nonterminal" do
+
+  before (:each) do
+    @g = Panini::Grammar.new
+    @n = @g.add_nonterminal()
+  end
+
+  it "returns a new Panini::Nonterminal" do
+    @n.should be_an_instance_of(Panini::Nonterminal)
+  end
+
+  it "stores the new Panini::Nonterminal" do
+    @g.nonterminals.should have(1).item
+    @g.nonterminals[0].should == @n
+  end
+
+end
+
+
+
+describe "Grammar#start" do
+
+  before (:each) do
+    @g = Panini::Grammar.new
+    @nonterminals = (0...3).to_a.map do
+      @g.add_nonterminal
+    end
+  end
+
+  it "returns the first nonterminal" do
+    @g.start.should == @nonterminals[0]
+  end
+
+end

data/spec/nonterminal_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "Nonterminal" do
+
+  before (:each) do
+    @n = Panini::Nonterminal.new
+  end
+
+  it "responds to #add_production" do
+    @n.should respond_to(:add_production)
+  end
+
+  it "responds to #productions" do
+    @n.should respond_to(:productions)
+  end
+
+end
+
+
+describe "Nonterminal#add_production with a non-Array arument" do
+
+  before (:each) do
+    @n = Panini::Nonterminal.new
+  end
+
+  it "throws an error" do
+    lambda { @n.add_production('a') }.should raise_error(ArgumentError, "The production must be an Array.")
+  end
+
+end
+
+
+describe "Nonterminal#add_production with a single production" do
+
+  before (:each) do
+    @n = Panini::Nonterminal.new
+    @p = @n.add_production(['a', 'b', 'c'])
+  end
+
+  it "returns nil" do
+    @p.should be_nil
+  end
+
+  it "stores the production" do
+    @n.productions.should have(1).item
+    @n.productions[0].should == ['a', 'b', 'c']
+  end
+
+end
+
+
+
+describe "Nonterminal#add_production with two productions" do
+
+  before (:each) do
+    @n = Panini::Nonterminal.new
+    @p1 = @n.add_production(['a', 'b', 'c'])
+    @p2 = @n.add_production(['x', 'y', 'z'])
+  end
+
+  it "returns nil" do
+    @p1.should be_nil
+    @p2.should be_nil
+  end
+
+  it "stores the productions" do
+    @n.productions.should have(2).items
+  end
+
+  it "stores the first one added first" do
+    @n.productions[0].should == ['a', 'b', 'c']    
+  end
+
+  it "stores the second one added last" do
+    @n.productions[1].should == ['x', 'y', 'z']    
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'panini'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/basic_derivation_strategy_shared_example.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+# Some basic tests to make sure that a strategy can deal with trivial
+# grammars.  Since these grammars can only create a single sentence, all
+# strategies should work.
+
+shared_examples_for "basic derivation strategy" do
+
+  describe "with the production S -> _epsilon_" do
+
+    before (:each) do
+      @g = Panini::Grammar.new
+      @n = @g.add_nonterminal
+      @n.add_production([])
+    end
+
+    it "generates an empty sentence" do 
+      d = described_class.new(@g)
+      d.sentence.should be_empty
+    end
+
+  end
+
+
+  describe "with the production S -> 'a'" do
+
+    before (:each) do
+      @g = Panini::Grammar.new
+      @n = @g.add_nonterminal
+      @n.add_production(['a'])
+    end
+
+    it "generates the sentence ['a']" do 
+      d = described_class.new(@g)
+      d.sentence.should == ['a']
+    end
+
+  end
+
+
+
+  describe "with the productions S -> A, A -> 'a'" do
+
+    before (:each) do
+      @g = Panini::Grammar.new
+
+      @n_s = @g.add_nonterminal
+      @n_a = @g.add_nonterminal
+
+      @n_s.add_production([@n_a])
+      @n_a.add_production(['a'])
+    end
+
+    it "generates the sentence ['a']" do 
+      d = described_class.new(@g)
+      d.sentence.should == ['a']
+    end
+
+  end
+
+
+
+  describe "with the productions S -> AB, A -> 'a', 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_b])
+      @n_a.add_production(['a'])
+      @n_b.add_production(['b'])
+    end
+
+    it "generates the sentence ['a', 'b']" do 
+      d = described_class.new(@g)
+      d.sentence.should == ['a', 'b']
+    end
+
+  end
+
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: panini
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- mjbellantoni
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Panini allows you to generate sentences from a context-free grammar, also known as a CFG.
+email: mjbellantoni@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/arithmetic_expression.rb
+- lib/derivation_strategy/base.rb
+- lib/derivation_strategy/leftmost.rb
+- lib/derivation_strategy/random_dampened.rb
+- lib/grammar.rb
+- lib/hash.rb
+- lib/nonterminal.rb
+- lib/panini.rb
+- panini.gemspec
+- spec/derivation_strategy/dampened_probability_production_choice_proxy_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
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 286269899475831067
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Create sentences from a context-free grammar (CFG)
+test_files: []
+