ffaker 1.7.0 → 1.8.0

data/README.rdoc

@@ -1,22 +1,22 @@
 = ffaker
 
-Fast Faker == Faker refactored, cleaner and faster.
+Fast Faker == Faker refactored. http://rubygems.org/gems/ffaker
 
 = Faker
 
-A port of Perl's Data::Faker library that generates fake data.
+A port of Perl's Data::Faker library that generates fake data. http://rubygems.org/gems/faker
 
 == Usage
 
   require 'ffaker'
-
   Faker::Name.name => "Christophe Bartell"
-
   Faker::Internet.email => "kirsten.greenholt@corkeryfisher.info"
 
 == Ffaker / Faker
 
-The are only two differences between faker and ffaker. The first one is that you need to
+Faker and Ffaker APIs are mostly the same, although the API on ffaker keeps
+growing with its users additions. In general, the only difference is that you
+need to:
 
   gem install ffaker
 
@@ -26,19 +26,15 @@ and then
 
 instead of "faker" with only one f.
 
-The API is pretty much the same as before.
-
-The second difference is that Faker::VERSION is no longer a module, so instead of accessing the version like this:
-
-  Faker::VERSION::STRING # faker
-
-you'll need to access it like this:
-
-  Faker::VERSION # ffaker
+== Faster? does it really matter ?
 
-Fork it/ping me if you feel like adding more goodies to it.
+Ffaker was initially written in an effort to speed up a slow spec suite. Bear
+in mind, if your spec suite is slow, chances are the generation of random data
+will not account for much of the run time.
 
-== Faster? does it really matter ?
+Since then, the original faker gem has become faster (at the moment it did not
+seem it was mantained). Nevertheless, ffaker is still about 20x faster than
+faker.
 
 $ cat scripts/benchmark.rb
 
@@ -53,21 +49,15 @@ $ cat scripts/benchmark.rb
     end
   end
 
-* ruby 1.8.7 (2009-06-12 patchlevel 174) [x86_64-linux], MBARI 0x6770, Ruby Enterprise Edition 2009.10
-
-                    user     system      total        real
-    Faker       9.240000   0.020000   9.260000 (  9.297381)
-    Fast Faker  0.060000   0.000000   0.060000 (  0.109047)
+* ruby 1.8.7 (2011-02-18 patchlevel 334) [x86_64-linux], MBARI 0x6770, Ruby Enterprise Edition 2011.03
 
-* ruby 1.9.1p376 (2009-12-07 revision 26041) [x86_64-linux]
+    generating 10000 names (faker 0.9.5)  1.500000   0.000000   1.500000 (  1.506865)
+    generating 10000 names (ffaker 1.5.0)  0.070000   0.000000   0.070000 (  0.067526)
 
-                    user     system      total        real
-    Faker      74.980000   0.110000  75.090000 ( 75.881142)
-    Fast Faker  0.050000   0.000000   0.050000 (  0.052292)
+* ruby 1.9.2p180 (2011-02-18 revision 30909) [x86_64-linux]
 
-DISCLAIMER: I have no idea why I'm getting such bad numbers
-for traditional faker on 1.9, but I'm not making this up.
-Try it in your own machine, your mileage may vary!
+    generating 10000 names (faker 0.9.5)  1.030000   0.020000   1.050000 (  1.046116)
+    generating 10000 names (ffaker 1.7.0)  0.040000   0.000000   0.040000 (  0.045917)
 
 == Contributors
 
@@ -81,12 +71,17 @@ Try it in your own machine, your mileage may vary!
 * David Noelte (https://github.com/marvin)
 * Port 80 Labs (https://github.com/port80labs)
 * Shane Weng (https://github.com/swcool)
+* Chris Bloom (https://github.com/chrisbloom7)
 
 == Changelog
 
+* 1.8.0
+
+  Added Faker::HTMLIpsum module inspired in http://html-ipsum.com/ (Thanks Chris Bloom, https://github.com/EmmanuelOga/ffaker/pull/18)
+
 * 1.7.0
 
-  Added Faker::LoremCN (Thanks Shane Weng, Shane Weng (https://github.com/swcool), https://github.com/EmmanuelOga/ffaker/pull/16/files)
+  Added Faker::LoremCN (Thanks Shane Weng, Shane Weng, https://github.com/swcool, https://github.com/EmmanuelOga/ffaker/pull/16/files)
 
 * 1.6.0
 

data/ffaker.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'ffaker'
-  s.version           = '1.7.0'
-  s.date              = '2011-05-19'
+  s.version           = '1.8.0'
+  s.date              = '2011-05-30'
   s.rubyforge_project = 'ffaker'
 
   s.summary     = "Faster Faker, generates dummy data."
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
     lib/ffaker/company.rb
     lib/ffaker/education.rb
     lib/ffaker/geolocation.rb
+    lib/ffaker/html_ipsum.rb
     lib/ffaker/internet.rb
     lib/ffaker/lorem.rb
     lib/ffaker/lorem_cn.rb
@@ -60,6 +61,7 @@ Gem::Specification.new do |s|
     test/test_faker_name_de.rb
     test/test_faker_name_ru.rb
     test/test_geolocation.rb
+    test/test_html_ipsum.rb
     test/test_lorem.rb
     test/test_lorem_cn.rb
     test/test_module_utils.rb

data/lib/ffaker.rb

@@ -1,5 +1,5 @@
 module Faker
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 
   require 'ffaker/utils/module_utils'
 
@@ -25,6 +25,7 @@ module Faker
   autoload :AddressDE,   'ffaker/address_de'
   autoload :Company,     'ffaker/company'
   autoload :Education,   'ffaker/education'
+  autoload :HTMLIpsum,   'ffaker/html_ipsum'
   autoload :Internet,    'ffaker/internet'
   autoload :Lorem,       'ffaker/lorem'
   autoload :LoremCN,     'ffaker/lorem_cn'

data/lib/ffaker/html_ipsum.rb

@@ -0,0 +1,160 @@
+module Faker
+  # Loosely based on http://html-ipsum.com/
+  # Requires Faker::Lorem module
+  module HTMLIpsum
+    extend ModuleUtils
+    extend self
+    
+    def a(word_count = 2)
+      "<a href=\"##{word}\" title=\"#{words(word_count).capitalize!}\">#{words(word_count).capitalize!}</a>"
+    end
+
+    def p(count = 3, options = {})
+      options = {:fancy => false, :include_breaks => false}.merge(options)
+      if options[:fancy]
+        s = fancy_string(count, options[:include_breaks])
+      else
+        mode = options[:include_breaks] ? "paragraphs" : "paragraph"
+        s = send(mode.to_sym, count)
+      end
+      "<p>#{s}</p>"
+    end
+    
+    def dl(definitions = 2)
+      s = "<dl>"
+      definitions.times do 
+        s << "<dt>#{words(1).capitalize!}</dt><dd>#{paragraph 2}</dd>"
+      end
+      s << "</dl>"
+    end
+    
+    def ul_short(items = 3)
+      s = "<ul>"
+      items.times do 
+        s << "<li>#{sentence 2}</li>"
+      end
+      s << "</ul>"
+    end
+    
+    def ul_long(items = 3)
+      s = "<ul>"
+      items.times do 
+        s << "<li>#{paragraph 2}</li>"
+      end
+      s << "</ul>"
+    end
+
+    def ol_short(items = 3)
+      s = "<ol>"
+      items.times do 
+        s << "<li>#{sentence 2}</li>"
+      end
+      s << "</ol>"
+    end
+    
+    def ol_long(items = 3)
+      s = "<ol>"
+      items.times do 
+        s << "<li>#{paragraph 2}</li>"
+      end
+      s << "</ol>"
+    end
+    
+    def ul_links(items = 3)
+      s = "<ul>"
+      items.times do 
+        s << "<li>#{a 1}</li>"
+      end
+      s << "</ul>"
+    end
+    
+    def table(rows = 3)
+      s = "<table>
+      	<thead>
+      		<tr>
+      			<th>#{word.capitalize!}</th>
+      			<th>#{word.capitalize!}</th>
+      			<th>#{word.capitalize!}</th>
+      			<th>#{word.capitalize!}</th>
+      		</tr>
+      	</thead>
+      	<tbody>"
+      rows.times do 
+        s << "<tr>
+    			<td>#{words(1).capitalize!}</td>
+    			<td>#{words(1).capitalize!}</td>
+    			<td>#{words(1).capitalize!}</td>
+    			<td>#{a}</td>
+    		</tr>"
+      end
+      s << "</tbody>
+      </table>"
+    end
+    
+    def body
+      s = "<h1>#{words(2).capitalize!}</h1>"
+      rand(4).times do
+        s << "<p>#{fancy_string}</p>"
+      end
+      s << table(rand(4))
+      s << "<h2>#{words(2).capitalize!}</h2>
+      <ol>"
+      rand(4).times do
+        s << "<li>#{paragraph 1}</li>"
+      end
+      s << "</ol>
+      <blockquote><p>#{paragraphs 3}</p></blockquote>
+      <h3>#{words(2).capitalize!}</h3>
+      <ul>"
+      rand(4).times do
+        s << "<li>#{paragraph 1}</li>"
+      end
+      s << "</ul>
+      <pre><code>
+      ##{word} h1 a { 
+      	display: block; 
+      	width: 300px; 
+      	height: 80px; 
+      }
+      </code></pre>"
+    end
+    
+    def fancy_string(count = 3, include_breaks = false)
+      sep  = include_breaks ? "<br>" : " "
+      a = k([
+        "<strong>#{words(2).capitalize!}</strong>.",
+        "<em>#{paragraph}</em>",
+        "<code>#{words 2}</code>",
+        "#{a 2}"
+      ] + Faker::Lorem::paragraphs(count))
+      a.random_pick(count).join(sep)
+    end
+
+  private
+  
+    def word
+      Faker::Lorem::word
+    end
+
+    def words(word_count = 3)
+      Faker::Lorem::words(word_count).join(' ')
+    end
+
+    def sentence(word_count = 3)
+      Faker::Lorem::sentence(word_count)
+    end
+
+    def sentences(sentence_count = 3)
+      Faker::Lorem::sentences(sentence_count).join(' ')
+    end
+
+    def paragraph(sentence_count = 3)
+      Faker::Lorem::paragraph(sentence_count)
+    end  
+
+    def paragraphs(paragraph_count = 3)
+      Faker::Lorem::paragraphs(paragraph_count).join('<br>')
+    end  
+
+  end 
+end

data/scripts/benchmark.rb

@@ -1,27 +1,20 @@
 require 'rubygems'
-
-begin
-  require 'ffaker'
-rescue LoadError
-  begin
-    require 'faker'
-  rescue LoadError
-    puts "You need to install either faker or ffaker to run this."
-  else
-    puts "Using Faker"
-  end
-else
-  puts "Using Fast Faker"
-end
-
 require 'benchmark'
 
 N = 10_000
 
-Benchmark.bm do |rep|
-  rep.report("generating #{ N } names") do
-    N.times do
-      Faker::Name.name
+def run(name)
+  require name
+  Benchmark.bm do |rep|
+    rep.report("generating #{ N } names (#{name} #{Faker::VERSION})") do
+      N.times do
+        Faker::Name.name
+      end
     end
   end
+  $stdout.flush
+  exit(0)
 end
+
+fork { run("faker") }; Process.wait
+fork { run("ffaker") }; Process.wait

data/test/test_html_ipsum.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+class TestHTMLIpsum < Test::Unit::TestCase
+  def setup
+    @tester = Faker::HTMLIpsum
+  end
+
+  def test_a
+    assert_match /^<a href="#\w+" title="[ \w]+">[ \w]+<\/a>$/i, Faker::HTMLIpsum.a
+  end
+  
+  def test_p
+    # We can't predict the number of times the sentence pattern will repeat
+    # because the Faker::Lorem methods that we are using adds a random
+    # number on top of what we specify for the count argument.
+    assert_match /^<p>([ \w]+\.)+<\/p>$/i, Faker::HTMLIpsum.p
+  end
+
+  def test_p_breaks
+    # Here we can at least test how many <br> tags there are.
+    assert_match /^<p>(?:[ \w\.]+<br>){2}[ \w\.]+<\/p>$/i, Faker::HTMLIpsum.p(3, {:include_breaks => true})
+  end
+
+  def test_p_fancy
+    # We can't predict the number of times the sentence pattern will repeat
+    # because the Faker::Lorem methods that we are using adds a random
+    # number on top of what we specify for the count argument. We also have to 
+    # account for the other HTML that is being returned.
+    assert_match /^<p>[[:alnum:][:punct:] <>\/]+<\/p>$/i, Faker::HTMLIpsum.p(5, {:fancy => true})
+  end
+  
+  def test_p_fancy_breaks
+    # Here we can at least test how many <br> tags there are. We also have to 
+    # account for the other HTML that is being returned.
+    assert_match /^<p>(?:[[:alnum:][:punct:] <>\/]+?<br>){9}[[:alnum:][:punct:] <>\/]+?<\/p>/i, Faker::HTMLIpsum.p(10, {:fancy => true, :include_breaks => true})
+  end
+  
+  def test_dl
+    assert_match /^<dl>(<dt>[ \w]+<\/dt><dd>[ \w.]+<\/dd>){3}<\/dl>$/i, Faker::HTMLIpsum.dl(3)
+  end
+  
+  def test_ul_short
+    assert_match /^<ul>(<li>[ \w.]+<\/li>){3}<\/ul>$/i, Faker::HTMLIpsum.ul_short(3)
+  end
+  
+  def test_ul_long
+    assert_match /^<ul>(<li>[ \w.]+<\/li>){3}<\/ul>$/i, Faker::HTMLIpsum.ul_long(3)
+  end
+
+  def test_ol_short
+    assert_match /^<ol>(<li>[ \w.]+<\/li>){3}<\/ol>$/i, Faker::HTMLIpsum.ol_short(3)
+  end
+  
+  def test_ol_long
+    assert_match /^<ol>(<li>[ \w.]+<\/li>){3}<\/ol>$/i, Faker::HTMLIpsum.ol_long(3)
+  end
+  
+  def test_ul_links
+    assert_match /^<ul>(<li><a href="#\w+" title="\w+">[ \w]+<\/a><\/li>){3}<\/ul>$/i, Faker::HTMLIpsum.ul_links(3)
+  end
+  
+  def test_table
+    assert_match /(<td>[ \w]+<\/td>\s*){3}/i, Faker::HTMLIpsum.table(3)
+  end
+
+  def test_body
+    # We can't reliably predict what's going to end up inside, so just ensure
+    # that we have a complete string.
+    assert_match /^<h1>.+<\/pre>$/im, Faker::HTMLIpsum.body
+  end
+  
+  def test_fancy_string
+    # We can't reliably predict what's going to end up inside, so just ensure
+    # that we have a complete string.
+    assert_match /^[[:alnum:][:punct:] <>\/]+$/im, Faker::HTMLIpsum.fancy_string
+  end
+  
+  def test_fancy_string_breaks
+    # We can't reliably predict what's going to end up inside, so just ensure
+    # that we have a complete string.
+    assert_match /^(?:[[:alnum:][:punct:] <>\/]+?<br>){2}[[:alnum:][:punct:] <>\/]+?$/im, Faker::HTMLIpsum.fancy_string(3, true)
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ffaker
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 55
+  prerelease: 
   segments: 
   - 1
-  - 7
+  - 8
   - 0
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors: 
 - Emmanuel Oga
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-19 00:00:00 -03:00
+date: 2011-05-30 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -39,6 +40,7 @@ files:
 - lib/ffaker/company.rb
 - lib/ffaker/education.rb
 - lib/ffaker/geolocation.rb
+- lib/ffaker/html_ipsum.rb
 - lib/ffaker/internet.rb
 - lib/ffaker/lorem.rb
 - lib/ffaker/lorem_cn.rb
@@ -65,6 +67,7 @@ files:
 - test/test_faker_name_de.rb
 - test/test_faker_name_ru.rb
 - test/test_geolocation.rb
+- test/test_html_ipsum.rb
 - test/test_lorem.rb
 - test/test_lorem_cn.rb
 - test/test_module_utils.rb
@@ -83,6 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -91,13 +95,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ffaker
-rubygems_version: 1.3.7
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 2
 summary: Faster Faker, generates dummy data.
@@ -113,6 +118,7 @@ test_files:
 - test/test_faker_name_de.rb
 - test/test_faker_name_ru.rb
 - test/test_geolocation.rb
+- test/test_html_ipsum.rb
 - test/test_lorem.rb
 - test/test_lorem_cn.rb
 - test/test_module_utils.rb