spintax_parser 0.1.0 → 0.2.0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 bundler_stubs/
+.ruby-version

data/.travis.yml

@@ -4,9 +4,9 @@ rvm:
   - "1.9.2"
   - "1.9.3"
   - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
+  # - jruby-19mode # JRuby in 1.9 mode throws some error about Random
   - rbx-18mode
   - rbx-19mode
   - ree
 # uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+# script: bundle exec rspec spec

data/README.md

@@ -1,6 +1,6 @@
-# SpintaxParser  [![Build Status](https://secure.travis-ci.org/flintinatux/spintax_parser.png)](http://travis-ci.org/flintinatux/spintax_parser)  [![Dependency Status](https://gemnasium.com/flintinatux/spintax_parser.png)](https://gemnasium.com/flintinatux/spintax_parser)  [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/flintinatux/spintax_parser)
+# SpintaxParser  [![Build Status](https://secure.travis-ci.org/flintinatux/spintax_parser.png)](http://travis-ci.org/flintinatux/spintax_parser)  [![Dependency Status](https://gemnasium.com/flintinatux/spintax_parser.png)](https://gemnasium.com/flintinatux/spintax_parser)  [![Code Climate](https://codeclimate.com/github/flintinatux/spintax_parser.png)](https://codeclimate.com/github/flintinatux/spintax_parser)
 
-A mixin to parse "spintax", a text format used for automated article generation. Can handle nested spintax, and can count the total number of unique variations.
+A mixin to parse "spintax", a text format used for automated article generation. Can handle nested spintax, and can count the total number of unique variations. Now also supports [consistent unspinning](#consistent-unspinning)!
 
 Read more about the motivation behind it at [the announcement of its initial release](http://madhackerdesigns.com/spintax_parser-gem-v0-0-1-released/ "spintax_parser gem v0.0.1 released").
 
@@ -22,17 +22,16 @@ Or install it yourself as:
 
 ## Usage
 
-Perhaps the simplest way to use it is to mix SpintaxParser directly into the global String class, like this:
+Perhaps the simplest way to use it is to mix `SpintaxParser` directly into the global `String` class, like this:
 
 ```ruby
 require 'spintax_parser'
-
 class String
   include SpintaxParser
 end
 ```
 
-Then you can safely call `unspin` on any string in your application:
+Then you can safely call `#unspin` on any string in your application:
 
 ```ruby
 spintext = "{Hello|Hi} {{world|worlds}|planet}{!|.|?}"
@@ -54,15 +53,27 @@ Run the code above, and you will end up with several random variations of the sa
     Hello world!
     Hello worlds.
 
-And don't worry: calling `unspin` on a string with no spintax will safely return an unaffected copy of the string.
+And don't worry: calling `#unspin` on a string with no spintax will safely return an unaffected copy of the string.
+
+Also, note that the `#unspin` method doesn't really care if the class you mix it into is a descendant of `String` or not, as long as its `#to_s` method returns a string written in spintax.
+
+### Consistent unspinning
+
+Got a special project that requires unspinning the same spintax the same way in certain circumstances? No problem. If you're using a Ruby version >= 1.9.3, you can pass a pre-seeded random number generator to the `#unspin` method just like you would to the `Array#sample` method. Et voila! Consistent unspinning!
+
+```ruby
+seed = Random.new_seed
+spintext.unspin :random => Random.new(seed)  # => "Hello world!"
+spintext.unspin :random => Random.new(seed)  # => "Hello world!"
+```
 
-Also, note that the `unspin` method doesn't really care if the class you mix it into is a descendant of String or not, as long as its `to_s` method returns a string written in spintax.
+### Counting total variations
 
-Now you can also count the total number of unique variations of a spintax string. If you've mixed the SpintaxParser into your String class like above, just call the `count_spintax_variations` method on any string as shown below:
+You can also count the total number of unique variations of a spintax string. If you've mixed the `SpintaxParser` into your `String` class like above, just call the `#count_spintax_variations` method on any string as shown below:
 
 ```ruby
 spintext = "{Hello|Hi} {{world|worlds}|planet}{!|.|?}"
-puts spintext.count_spintax_variations   # => 18
+spintext.count_spintax_variations  # => 18
 ```
 
 ## Contributing

data/lib/spintax_parser/version.rb

@@ -1,3 +1,3 @@
 module SpintaxParser
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/spintax_parser.rb

@@ -1,14 +1,14 @@
-require "spintax_parser/version"
-require "backports" if RUBY_VERSION < "1.9"
+require 'spintax_parser/version'
+require 'backports/1.9.1/array/sample' if RUBY_VERSION < '1.9.1'
 
 module SpintaxParser
   
   SPINTAX_PATTERN = %r/\{([^{}]*)\}/
 
-  def unspin
+  def unspin(options={})
     spun = dup.to_s
     while spun =~ SPINTAX_PATTERN
-      spun.gsub!(SPINTAX_PATTERN) { $1.split('|').sample }
+      parse_the_spintax_in spun, options
     end
     spun
   end
@@ -25,4 +25,15 @@ module SpintaxParser
     eval spun
   end
 
-end # SpintaxParser
+  private
+
+    if RUBY_VERSION >= '1.9.3'
+      def parse_the_spintax_in(spun, options={})
+        spun.gsub!(SPINTAX_PATTERN) { $1.split('|').sample(options) }
+      end
+    else
+      def parse_the_spintax_in(spun, options={})
+        spun.gsub!(SPINTAX_PATTERN) { $1.split('|').sample }
+      end
+    end
+end

data/spec/lib/spintax_parser_spec.rb

@@ -12,21 +12,19 @@ describe SpintaxParser do
 
   describe "calling unspin" do
     
-    describe "on plaintext" do
-      
-      it "should not change the plaintext" do
+    context "on plaintext" do
+      it "does not change the plaintext" do
         expect { plaintext.unspin }.not_to change { plaintext }
       end
 
       let(:result) { plaintext.unspin }
-      it "should return the same plaintext" do
+      it "returns the same plaintext" do
         result.should == plaintext
       end
     end
 
-    describe "on spintext" do
-      
-      it "should not change the spintext" do
+    context "on spintext" do
+      it "does not change the spintext" do
         expect { spintext.unspin }.not_to change { spintext }
       end
 
@@ -35,6 +33,17 @@ describe SpintaxParser do
       it { should_not == spintext }
       it { should_not =~ spintax_pattern }
     end
+
+    if RUBY_VERSION >= '1.9.3'
+      context "with the same rng supplied" do
+        it "produces the same unspun version each time" do
+          seed = Random.new_seed
+          unspun1 = spintext.unspin :random => Random.new(seed)
+          unspun2 = spintext.unspin :random => Random.new(seed)
+          unspun1.should eq unspun2
+        end
+      end
+    end
   end
 
   it "should count spun variations correctly" do
@@ -44,4 +53,4 @@ describe SpintaxParser do
     'one {{two|three} four|five {six|seven}} eight {nine|ten}'.count_spintax_variations.should eq 8
     '{Hello|Hi} {{world|worlds}|planet}{!|.|?}'.count_spintax_variations.should eq 18
   end
-end
+end

data/spintax_parser.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/spintax_parser/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Scott McCormack"]
   gem.email         = ["mail@madhackerdesigns.com"]
-  gem.description   = %q{A mixin to parse "spintax", a text format used for automated article generation. Can handle nested spintax, and can count the total number of unique variations.}
+  gem.description   = %q{A mixin to parse "spintax", a text format used for automated article generation. Can handle nested spintax, and can count the total number of unique variations. Now also supports consistent unspinning!}
   gem.summary       = gem.description
   gem.homepage      = "https://github.com/flintinatux/spintax_parser"
 
@@ -15,6 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SpintaxParser::VERSION
 
-  gem.add_dependency 'backports'
-  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_dependency 'backports', '~> 3.3'
+  gem.add_development_dependency 'rspec', '~> 2.12'
 end

metadata

@@ -1,57 +1,62 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: spintax_parser
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Scott McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: backports
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-05-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 3
+        version: "3.3"
+  name: backports
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-description: A mixin to parse "spintax", a text format used for automated article
-  generation. Can handle nested spintax, and can count the total number of unique
-  variations.
-email:
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  name: rspec
+  prerelease: false
+  type: :development
+  requirement: *id002
+description: A mixin to parse "spintax", a text format used for automated article generation. Can handle nested spintax, and can count the total number of unique variations. Now also supports consistent unspinning!
+email: 
 - mail@madhackerdesigns.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -64,34 +69,36 @@ files:
 - spintax_parser.gemspec
 homepage: https://github.com/flintinatux/spintax_parser
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 4151852987598141644
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 4151852987598141644
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A mixin to parse "spintax", a text format used for automated article generation.
-  Can handle nested spintax, and can count the total number of unique variations.
-test_files:
+summary: A mixin to parse "spintax", a text format used for automated article generation. Can handle nested spintax, and can count the total number of unique variations. Now also supports consistent unspinning!
+test_files: 
 - spec/lib/spintax_parser_spec.rb