permutations 0.1.3 → 0.1.4

data/{Readme.rdoc → Readme.md}

@@ -1,39 +1,48 @@
-= Permutations
+Permutations
+============
 
 Generate permutations for nested arrays or strings that offer one or more choices.
 
-== Installation
+Installation
+------------
 
 You can use it as a Rails plugin or as a normal ruby.
 
-  script/plugin install git://github.com/Narnach/permutations.git
+    script/plugin install git://github.com/Narnach/permutations.git
 
 or
 
-  sudo gem install permutations
+    sudo gem install permutations
 
-== Example
+Example
+-------
 
 You can permutate array elements:
-  require 'permutations'
-  [[1,2],[3,4]].permutations # =>[[1,3],[1,4],[2,3],[2,4]]
+
+    require 'permutations'
+    [[1,2],[3,4]].permutations # =>[[1,3],[1,4],[2,3],[2,4]]
 
 You can also permutate choice sets extraced from strings. These choices are specified between curly braces:
-  "{1,2}{3,4}".permutations # => ["13", "14", "23", "24"]
+
+    "{1,2}{3,4}".permutations # => ["13", "14", "23", "24"]
 
 It is possible to use a custom separator, and whitespace surrounding options is automatically removed to allow for more reader-friendly formatting of the choicees:
-  "{ 1 | 2 }{ 3 | 4 }".permutations("|") # => ["13", "14", "23", "24"]
+
+    "{ 1 | 2 }{ 3 | 4 }".permutations("|") # => ["13", "14", "23", "24"]
 
 By default (custom) separators are regexp-escaped, but this can be turned off to use a regexp to determine the separation; for example when there are multiple separators:
-  "{1|2}{3,4}".permutations("[|,]", false) # => ["13", "14", "23", "24"]
 
-== Contributing
+    "{1|2}{3,4}".permutations("[|,]", false) # => ["13", "14", "23", "24"]
+
+Contributing
+------------
 
-Bugs and feature requests can be added in Lighthouse. Pull requests on github are welcome, too.
-When you submit code, it is very much appreciated when have specs and perhaps a bit of documentation for new features.
+Bugs and feature requests can be added in Lighthouse. Pull requests on Github are welcome, too.
+When you submit code, it is very much appreciated when you have specs and perhaps a bit of documentation for new features.
 
 https://narnach.lighthouseapp.com/projects/45010-permutations
 
-== Credits
+Credits
+-------
 
 Created by Wes Oldenbeuving. Licensed under the MIT License.

data/lib/permutations.rb

@@ -1,7 +1,9 @@
 module Permutations
   module Array
-    # Recursively permutate nested arrays.
-    #   [[1,2],[3,4]].permutations # =>[[1,3],[1,4],[2,3],[2,4]]
+    # @param [Array] leftovers remaining elements to recursively permutate through.
+    # @return [Array] Nested array with all permutations
+    # @example
+    #   [[1,2],[3,4]].permutations   #=> [[1,3],[1,4],[2,3],[2,4]]
     def permutations(leftovers=self)
       tail = leftovers.last
       return tail.map{|e| [e]} if leftovers.size == 1
@@ -16,8 +18,11 @@ module Permutations
   end
 
   module String
-    # Create all possible string permutations of the available choice groups.
-    #   "{a,b,c}{1,2,3}".permutations # => ["a1", "a2", "a3", "b1", "b2", "b3", "c1", "c2", "c3"]
+    # @param [String] separator Pattern to split the string on
+    # @param [TrueClass, FalseClass] escape_separator Wether to Regexp-escape the separator and treat it as a literal separator (true) or treat it as a regexp (false)
+    # @return [Array] Nested array with all permutations
+    # @example
+    #   "{a,b,c}{1,2,3}".permutations   #=> ["a1", "a2", "a3", "b1", "b2", "b3", "c1", "c2", "c3"]
     def permutations(separator=',', escape_separator=true)
       separator=Regexp.escape(separator) if escape_separator
       matches = self.scan(/(\{\s*(.*?)\s*\})/)

data/permutations.gemspec

@@ -3,15 +3,15 @@ Gem::Specification.new do |s|
   s.name         = 'permutations'
   s.summary      = "Permutations is a library that allows you to generate permutations from Arrays and Strings."
   s.description  = s.summary
-  s.version      = '0.1.3'
-  s.date         = '2010-02-01'
+  s.version      = '0.1.4'
+  s.date         = '2011-11-23'
   s.platform     = Gem::Platform::RUBY
   s.authors      = ["Wes Oldenbeuving"]
   s.email        = "narnach@gmail.com"
   s.homepage     = "http://www.github.com/narnach/permutations"
 
   # Files
-  root_files     = %w[Readme.rdoc Rakefile permutations.gemspec init.rb MIT-LICENSE]
+  root_files     = %w[Readme.md Rakefile permutations.gemspec init.rb MIT-LICENSE]
   bin_files      = []
   lib_files      = %w[permutations]
   s.bindir       = "bin"
@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
 
   # rdoc
   s.has_rdoc         = true
-  s.extra_rdoc_files = %w[ Readme.rdoc]
-  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'Readme.rdoc'
+  s.extra_rdoc_files = %w[ Readme.md]
+  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'Readme.md'
 
   # Requirements
   s.required_ruby_version = ">= 1.8.0"

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: permutations
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Wes Oldenbeuving
@@ -9,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-01 00:00:00 +01:00
-default_executable: 
+date: 2011-11-23 00:00:00 Z
 dependencies: []
 
 description: Permutations is a library that allows you to generate permutations from Arrays and Strings.
@@ -20,15 +25,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- Readme.rdoc
+- Readme.md
 files: 
-- Readme.rdoc
+- Readme.md
 - Rakefile
 - permutations.gemspec
 - init.rb
 - MIT-LICENSE
 - lib/permutations.rb
-has_rdoc: true
 homepage: http://www.github.com/narnach/permutations
 licenses: []
 
@@ -37,25 +41,33 @@ rdoc_options:
 - --inline-source
 - --line-numbers
 - --main
-- Readme.rdoc
+- Readme.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 55
+      segments: 
+      - 1
+      - 8
+      - 0
       version: 1.8.0
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Permutations is a library that allows you to generate permutations from Arrays and Strings.