content_spinning 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,7 @@
 # Content Spinning
 
-content_spinning is a ruby lib to spin some text.
+`ContentSpinning` is a ruby library made to spin some text.
+It manages nested spinning.
 
 ## Example
 
@@ -13,7 +14,12 @@ ContentSpinning.spin "Hi {there|you}! I'm {efficient|productive}."
 returns this array :
 
 ```ruby
-["Hi there! I'm efficient.", "Hi there! I'm productive.", "Hi you! I'm efficient.", "Hi you! I'm productive."]
+[
+  "Hi there! I'm efficient.",
+  "Hi there! I'm productive.",
+  "Hi you! I'm efficient.",
+  "Hi you! I'm productive."
+]
 ```
 
 ## Install
@@ -22,3 +28,9 @@ returns this array :
 gem install content_spinning
 ```
 
+## Todo
+
+A few things to do :
+
+* Executable
+

data/lib/content_spinning.rb

@@ -2,64 +2,79 @@ module ContentSpinning
   class << self
 
     def spin(text)
+      text = clean(text)
       result = parse(text)
+
       spin_all_level(result[:parsed], result[:max_level])
     end
 
+    def clean(text)
+      begin
+        text_before_run = text.clone
+
+        # Strip empty spin
+        text.gsub!(/\{\|*\}/, '')
+
+        # Remove spin with only one choice
+        text.gsub!(/\{([^\{\}\|]+)\}/, '\1')
+
+      end while (text != text_before_run)
+
+      text
+    end
+
     def parse(text, level = 1)
       return {:parsed => text, :max_level => level - 1} unless text.include? "{"
 
-      text.gsub!(/\{\}/, '')
-      text.gsub!(/\{([^\{\}\|]+)\}/, '\1')
-
       text.gsub!(/\{([^\{\}]+)\}/) do |match|
-        match.gsub!(/\{/, "__SPIN_BEGIN_" + level.to_s + "__")
-        match.gsub!(/\}/, "__SPIN_END_" + level.to_s + "__")
-        match.gsub!(/\|/, "__SPIN_OR_" + level.to_s + "__")
+        match.gsub!(/\{/, "__SPIN_BEGIN_#{level}__")
+        match.gsub!(/\}/, "__SPIN_END_#{level}__")
+        match.gsub!(/\|/, "__SPIN_OR_#{level}__")
       end
 
       parse(text, level+1)
     end
 
     def spin_a_level(text_or_array, level)
-      text_or_array = [text_or_array] unless text_or_array.is_a? Array
-
-      spin_begin = '__SPIN_BEGIN_' + level.to_s + '__'
-      spin_end = '__SPIN_END_' + level.to_s + '__'
-      spin_or = '__SPIN_OR_' + level.to_s + '__'
-
-      text_or_array.map! do |text|
-        return [text] unless text.include? spin_begin
-
-        array = text.partition(Regexp.new(spin_begin + '.+?' + spin_end))
-        #puts array.inspect
-
-        deb = array[0]
-        fin = array[2]
-
-        vary = array[1]
-        vary.gsub!(Regexp.union(spin_begin, spin_end), '')
-        varies = vary.split(Regexp.new(spin_or))
-
-        varies.map! do |vary|
-          spin_a_level([deb + vary + fin], level)
+      content_array = text_or_array.is_a?(Array) ? text_or_array : [text_or_array]
+
+      spin_begin = "__SPIN_BEGIN_#{level}__"
+      spin_end = "__SPIN_END_#{level}__"
+      spin_or = "__SPIN_OR_#{level}__"
+
+      content_array.map! do |text|
+        if text.include? spin_begin
+          # Spin a first one
+          before, vary, after = text.partition(Regexp.new(spin_begin + '.+?' + spin_end))
+          vary.gsub!(Regexp.union(spin_begin, spin_end), '')
+
+          varies = vary.split(Regexp.new(spin_or), -1)
+          varies.map! { |vary| before + vary + after }
+
+          # Continue spinning the level if there are other same level spin or just return
+          if after.include? spin_begin
+            spin_a_level(varies, level).flatten
+          else
+            varies
+          end
+        else
+          text
         end
-
-        varies
       end
 
-      text_or_array.flatten
+      content_array.flatten
     end
 
     def spin_all_level(text_or_array, from_level)
-      text_or_array = [text_or_array] unless text_or_array.is_a? Array
-      return text_or_array if from_level == 0
+      content_array = text_or_array.is_a?(Array) ? text_or_array : [text_or_array]
 
-      (1..from_level).reverse_each do |level|
-        text_or_array = spin_a_level(text_or_array, level)
+      if from_level > 0
+        (1..from_level).reverse_each do |level|
+          content_array = spin_a_level(content_array, level)
+        end
       end
 
-      text_or_array
+      content_array.delete_if(&:empty?).uniq
     end
 
   end

data/lib/content_spinning/version.rb

@@ -1,6 +1,6 @@
 module ContentSpinning
   module Version
-    STRING = '0.0.1'
+    STRING = '0.0.2'
   end
 end
 

data/spec/content_spinning_spec.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe String do
+
+  describe "spin" do
+    it "should be defined" do
+      String.new.respond_to?(:spin).should be_true
+    end
+    it "should call the spin function of ContentSpinning module with the string in argument" do
+      ContentSpinning.should_receive(:spin).with("AaBb")
+      "AaBb".spin
+    end
+  end
+
+end
+
+describe ContentSpinning do
+
+  describe "clean" do
+    it "should return the string if there is no spin" do
+      ContentSpinning.clean("AaBb").should eq "AaBb"
+    end
+
+    it "should strip empty spin" do
+      ContentSpinning.clean("a{}").should eq "a"
+      ContentSpinning.clean("a{|}").should eq "a"
+      ContentSpinning.clean("a{||}").should eq "a"
+      ContentSpinning.clean("{}a{}").should eq "a"
+      ContentSpinning.clean("{}a{|}").should eq "a"
+
+      ContentSpinning.clean("a{{}}").should eq "a"
+      ContentSpinning.clean("a{{|}}").should eq "a"
+      ContentSpinning.clean("a{{}|}").should eq "a"
+
+      ContentSpinning.clean("a{a{}}").should eq "aa"
+    end
+
+    it "should remove spin with no choice" do
+      ContentSpinning.clean("{a}").should eq "a"
+      ContentSpinning.clean("a{b}").should eq "ab"
+      ContentSpinning.clean("a{b}c").should eq "abc"
+      ContentSpinning.clean("a{b}c{d}e").should eq "abcde"
+
+      ContentSpinning.clean("{{a}}").should eq "a"
+      ContentSpinning.clean("a{{b}}").should eq "ab"
+      ContentSpinning.clean("a{{b}}c").should eq "abc"
+      ContentSpinning.clean("a{{b}}c{{d}}e").should eq "abcde"
+
+      ContentSpinning.clean("{{{a}}}").should eq "a"
+    end
+
+    it "should keep legitimate spin" do
+      ContentSpinning.clean("{a|b}").should eq "{a|b}"
+      ContentSpinning.clean("a{b|c}").should eq "a{b|c}"
+      ContentSpinning.clean("{{a|b}|c}").should eq "{{a|b}|c}"
+    end
+  end
+
+  describe "parse" do
+    it "should return the string if there is no spin" do
+      ContentSpinning.parse("AaBb").should eq :max_level => 0, :parsed => "AaBb"
+    end
+
+    it "should parse simple spin" do
+      ContentSpinning.parse("{a|b}").should eq :max_level => 1, :parsed => "__SPIN_BEGIN_1__a__SPIN_OR_1__b__SPIN_END_1__"
+      ContentSpinning.parse("a{b|c}").should eq :max_level => 1, :parsed => "a__SPIN_BEGIN_1__b__SPIN_OR_1__c__SPIN_END_1__"
+      ContentSpinning.parse("{a|b}c{d|e}").should eq :max_level => 1, :parsed => "__SPIN_BEGIN_1__a__SPIN_OR_1__b__SPIN_END_1__c__SPIN_BEGIN_1__d__SPIN_OR_1__e__SPIN_END_1__"
+    end
+
+    it "should manage recursive spin" do
+      ContentSpinning.parse("{{a|b}|c}").should eq :max_level => 2, :parsed => "__SPIN_BEGIN_2____SPIN_BEGIN_1__a__SPIN_OR_1__b__SPIN_END_1____SPIN_OR_2__c__SPIN_END_2__"
+      ContentSpinning.parse("{a|{b|c}}").should eq :max_level => 2, :parsed => "__SPIN_BEGIN_2__a__SPIN_OR_2____SPIN_BEGIN_1__b__SPIN_OR_1__c__SPIN_END_1____SPIN_END_2__"
+    end
+  end
+
+  describe "spin" do
+    it "should call the clean function of ContentSpinning module with the string in argument" do
+      ContentSpinning.should_receive(:clean).with("AaBb").and_return("AaBb")
+      ContentSpinning.spin("AaBb")
+    end
+
+    it "should return an array" do
+      "AaBb".spin.should eq ["AaBb"]
+    end
+
+    it "should return an empty array if the string to spin is empty" do
+      "".spin.should eq []
+    end
+
+    it "should strip empty choices" do
+      "a{}".spin.should eq ["a"]
+      "a{|}".spin.should eq ["a"]
+      "a{||}".spin.should eq ["a"]
+      "{}a{}".spin.should eq ["a"]
+      "{}a{|}".spin.should eq ["a"]
+    end
+
+    it "should strip empty strings from the returned array" do
+      "{|a}".spin.should eq ["a"]
+      "{a|}".spin.should eq ["a"]
+    end
+
+    it "should manage one spin" do
+      "{a}".spin.should eq ["a"]
+      "a{b}".spin.should eq ["ab"]
+      "a{b}c".spin.should eq ["abc"]
+      "{a}{b}".spin.should eq ["ab"]
+      "a{b}{c}d".spin.should eq ["abcd"]
+    end
+
+    it "should manage two spin" do
+      "{a}".spin.should eq ["a"]
+      "a{b}".spin.should eq ["ab"]
+      "a{b}c".spin.should eq ["abc"]
+      "{a}{b}".spin.should eq ["ab"]
+      "a{b}{c}d".spin.should eq ["abcd"]
+    end
+
+    it "should manage spin with an empty choice" do
+      "{|a}".spin.should eq ["a"]
+      "{|a}b".spin.should eq ["b", "ab"]
+      "{a|}b".spin.should eq ["ab", "b"]
+      "{a|}{b|}".spin.should eq ["ab", "a", "b"]
+      "a{b|}{c|}d".spin.should eq ["abcd", "abd", "acd", "ad"]
+    end
+
+    it "should manage spin with two choice" do
+      "{a|b}".spin.should eq ["a", "b"]
+      "{a|b}c".spin.should eq ["ac", "bc"]
+      "{a|b}{c|d}".spin.should eq ["ac", "ad", "bc", "bd"]
+    end
+
+    it "should manage spin with three choice" do
+      "{a|b|c}".spin.should eq ["a", "b", "c"]
+      "{a|b|c}d".spin.should eq ["ad", "bd", "cd"]
+      "{a|b|c}{d|e}".spin.should eq ["ad", "ae", "bd", "be", "cd", "ce"]
+    end
+
+    it "should manage recursive spin" do
+      "{a{b|c}|d}".spin.should eq ["ab", "ac", "d"]
+      "{{a|b}|c}".spin.should eq ["a", "b", "c"]
+      "{a|{b|c}}".spin.should eq ["a", "b", "c"]
+    end
+
+    it "should not return twice the same result" do
+      "{a|a}".spin.should eq ["a"]
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'content_spinning'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_spinning
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000 Z
-dependencies: []
+date: 2012-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11429000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *11429000
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &11428420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11428420
 description: ! "    To spin some text, mainly for SEO purpose.\n\n    Spinning the
   string \"Hi {there|you}! I'm {efficient|productive}.\" gives\n    these four strings
   :\n\n    * Hi there! I'm efficient.\n    * Hi there! I'm productive.\n    * Hi you!
@@ -25,6 +47,8 @@ files:
 - LICENSE
 - lib/content_spinning/version.rb
 - lib/content_spinning.rb
+- spec/content_spinning_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/maximeg/content_spinning
 licenses: []
 post_install_message: 
@@ -49,4 +73,6 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Content Spinning
-test_files: []
+test_files:
+- spec/content_spinning_spec.rb
+- spec/spec_helper.rb