sixarm_ruby_fab 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cfd05a4915d109badc07b3de31b368a094764e4
+  data.tar.gz: b1308a6558b30ddd6f44f7003d93302ae5ddbc19
+SHA512:
+  metadata.gz: 9ce73304f967d12d5a7e24b37c8dd5a0666581fae01ff4b6a41b5ac7ed05b12704b497e90a325c53b542004e9b30c472f1070acec5464b1f5e5cdca64036895e
+  data.tar.gz: 747bde33626df662131b4661c1df943890bd67fa175f35368c81e99ee49149b64e45475a1d2343211189d5dec69c3350596773d86b6c657bec5098d4f31a3573

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+��*�j�������n
�@��x�sR`��rX’�Q֍B

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Thank you for contributing!
+
+If you would like to contribute a donation, an easy way is to use PayPal to sixarm@sixarm.com.
+
+If you would like to contribute help, the next section is for you.
+
+
+## Contributing to the source
+
+We love pull requests for improvments to the source code and documentation.
+
+There are three easy steps:
+
+1. Fork the repo. 
+
+  * Before you do any work please run our existing tests to make sure the code runs cleanly.
+
+2. Work as you like. 
+
+   * Please create tests. This helps us know that all your code runs cleanly.
+
+3. Push to your fork and submit a pull request.
+
+   * We'll take a look as soon as we can; this is typically within a business day.
+
+Thank you again!

data/README.md

@@ -0,0 +1,91 @@
+# SixArm.com » Ruby » <br> Fab gem for fabricated sample data for testing
+
+* Doc: <http://sixarm.com/sixarm_ruby_fab/doc>
+* Gem: <http://rubygems.org/gems/sixarm_ruby_fab>
+* Repo: <http://github.com/sixarm/sixarm_ruby_fab>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+## Introduction
+
+Fabricate sample data suitable for testing.
+
+Requires the Forgery gem.
+
+For docs go to <http://sixarm.com/sixarm_ruby_fab/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Install quickstart
+
+Install:
+
+    gem install sixarm_ruby_fab
+
+Bundler:
+
+    gem "sixarm_ruby_fab", "~>1.0.0"	
+
+Require:
+
+    require "sixarm_ruby_fab"
+
+
+## Install with security (optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_fab --test --trust-policy HighSecurity
+
+
+## Examples
+
+Create a fab:
+
+    require "sixarm_ruby_fab"
+    fab = Fab.new
+
+Use it:
+
+    fab.email_address #=> "foo@bar.com"
+    fab.street_address #=> "123 Main Street"
+
+
+## Changes
+
+* 2013-08-01 1.0.0 Publish.
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+The software is provided "as is", without warranty of any kind, 
+express or implied, including but not limited to the warranties of 
+merchantability, fitness for a particular purpose and noninfringement. 
+
+In no event shall the authors or copyright holders be liable for any 
+claim, damages or other liability, whether in an action of contract, 
+tort or otherwise, arising from, out of or in connection with the 
+software or the use or other dealings in the software.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2013 Joel Parker Henderson

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sixarm_ruby_fab.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+require 'pathname'
+require 'securerandom'
+require 'forgery'  # gem
+require 'sixarm_ruby_fab/forgery/geo'
+require 'sixarm_ruby_fab/forgery/uri'
+
+class Fab
+  AZ = ('a'..'z').to_a
+end
+
+[
+  'agent',
+  'basic',
+  'company',
+  'date', 
+  'datetime',
+  'email',
+  'files',
+  'geo',
+  'id',
+  'internet',
+  'locale',
+  'mime',
+  'names',
+  'password',
+  'phone',
+  'postal',
+  'text',
+  'time',
+  'twitter',
+  'username',
+  'uuid'
+].each{|x|
+  require "sixarm_ruby_fab/#{x}.rb"
+}

data/lib/sixarm_ruby_fab/agent.rb

@@ -0,0 +1,20 @@
+class Fab
+
+  AGENT_LIST = [
+    "Mozilla/5.0 (iPhone; CPU iPhone OS 5_0_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Mobile/9A405",
+    "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Mobile/9B179",
+    "Mozilla/5.0 (Linux; U; Android 2.3.5; en-us; SCH-I500 Build/GINGERBREAD) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1",
+    "Mozilla/5.0 (Linux; U; Android 4.0.3; en-us; EVO Build/IML74K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30"
+  ]
+
+  attr_accessor :agent_list
+
+  def agent
+    agent_list.sample
+  end
+
+  def agent_list
+    @agent_list ||= AGENT_LIST
+  end
+
+end

data/lib/sixarm_ruby_fab/basic.rb

@@ -0,0 +1,26 @@
+class Fab
+
+  # Fab a boolean, either true or false.
+  #
+  # @return [boolean] either true or false.
+  #
+  def boolean
+    [true, false].sample
+  end
+
+  # Fab a rating, such as 1 to 5 stars.
+  #
+  # Options:
+  #
+  #   * min: 1
+  #   * max: 5
+  #
+  # @return [Fixnum] a random number
+  #
+  def rating(options = {})
+    rand((options[:min] || 1)..(options[:max] || 5))
+  end
+
+end
+
+

data/lib/sixarm_ruby_fab/company.rb

@@ -0,0 +1,21 @@
+class Fab
+
+  # Fab a company name.
+  # Delegates to Forgery::Name.company_name.
+  #
+  # @returns [String] a random company name
+  #
+  def company_name(options = {})
+    Forgery::Name.company_name
+  end
+
+  # Fab a job title.
+  # Delegates to Forgery::Name.job_title.
+  #
+  # @returns [String] a random company name
+  #
+  def job_title(options = {})
+    Forgery::Name.job_title
+  end
+
+end

data/lib/sixarm_ruby_fab/date.rb

@@ -0,0 +1,45 @@
+class Fab
+
+  # Fab a random date.
+  #
+  # Options:
+  #
+  #   * min: today - 1000 
+  #   * max: today + 1000
+  #
+  # @returns [Date] a random date min..max
+  #
+  def date(options = {})
+    rand((options[:min] || Date.today - 1000)..(options[:max] || Date.today + 1000))
+  end
+
+  # Fab a random start date.
+  # Delegates to #date.
+  #
+  # @returns [Date] a random date min..max
+  #
+  def start_date(options = {})
+    date(options)
+  end
+
+  # Fab a random stop date.
+  # Delegates to #date.
+  #
+  # @returns [Date] a random date min..max
+  #
+  def stop_date(options = {})
+    date(options)
+  end
+
+  # Fab a random start date and stop date.
+  # The start is less than or equal to the stop.
+  # Delegates to #start_date and #stop_date.
+  #
+  # @returns [Date,Date] a random [start date, stop date] from min..max
+  #
+  def start_date_and_stop_date(options = {})
+    [start_date(options), stop_date(options)].sort
+  end
+
+end
+

data/lib/sixarm_ruby_fab/datetime.rb

@@ -0,0 +1,44 @@
+class Fab
+  
+  # Fab a random datetime.
+  #
+  # Options:
+  #
+  #   * min: now - 1000 
+  #   * max: now + 1000
+  #
+  # @returns [DateTime] a random datetime min..max
+  #
+  def datetime(options = {})
+    rand((options[:min] || DateTime.now - 1000)..(options[:max] || DateTime.now + 1000))
+  end
+
+  # Fab a random start datetime.
+  # Delegates to #datetime.
+  #
+  # @returns [DateTime] a random datetime min..max
+  #
+  def start_datetime(options = {})
+    datetime(options)
+  end
+
+  # Fab a random stop datetime.
+  # Delegates to #datetime.
+  #
+  # @returns [DateTime] a random datetime min..max
+  #
+  def stop_datetime(options = {})
+    datetime(options)
+  end
+
+  # Fab a random start datetime and stop datetime.
+  # The start is less than or equal to the stop.
+  # Delegates to #start_datetime and #stop_datetime.
+  #
+  # @returns [DateTime,DateTime] a random [start datetime, stop datetime] from min..max
+  #
+  def start_datetime_and_stop_datetime(options = {})
+    [start_datetime(options), stop_datetime(options)].sort
+  end
+
+end

data/lib/sixarm_ruby_fab/email.rb

@@ -0,0 +1,12 @@
+class Fab
+
+  # Fab an email address.
+  # Delegate to Forgery::Email.address
+  #
+  # @returns [String] an email address
+  #
+  def email_address
+    Forgery::Email.address
+  end
+
+end

data/lib/sixarm_ruby_fab/files.rb

@@ -0,0 +1,113 @@
+class Fab
+
+  CHARS = ('a'..'z').to_a
+
+  # Fab a path e.g. "/mydir1/mydir2/myfile.txt"
+  #
+  # @returns [String] a path 
+  #
+  def path(options = {})
+    (Pathname.new("") + dirname(options) + basename(options)).to_s
+  end
+
+  # Fab a base name e.g. "myfile.txt"
+  #
+  # The base name has two parts:
+  #
+  #   * The "intension" e.g. "myfile"
+  #   * The "extension" e.g. "txt"
+  #
+  # Options:
+  #
+  #   * chars: a..z
+  #   * intension_length: [sent to #basename_intension as :length]
+  #   * extension_length: [sent to #basename_extension as :length]
+  # 
+  # @returns [String] a base name
+  #
+  def basename(options = {})
+    intention = basename_intension(options[:intension_length] ? options.merge(length: intension_length) : options)
+    extention = basename_extension(options[:extension_length] ? options.merge(length: extension_length) : options)
+    "#{basename_intension}.#{basename_extension}"
+  end
+
+  # Fab a file base name intension e.g. "myfile"
+  #
+  # Options:
+  #
+  #   * chars: a..z
+  #   * length: rand(1..30)
+  #
+  # @returns [String] a base name intension
+  #
+  def basename_intension(options = {})
+    (options[:chars] || AZ).sample(options[:size] || rand(1..30)).join
+  end
+
+  # Fab a file base name extension e.g. "txt"
+  #
+  # Options:
+  #
+  #   * chars: a..z
+  #   * length: rand(1..5)
+  #
+  # @returns [String] a base name extension
+  #
+  def basename_extension(options = {})
+    (options[:chars] || AZ).sample(options[:size] || rand(1..5)).join
+  end
+
+  # Fab a directory name e.g. "/mydir1/mydir2".
+  # This calls #dirname_part +rand+ times.
+  #
+  # Options:
+  # 
+  #   * parts: rand(2..6) [how many parts to use]
+  #   * chars: a..z [sent to #dirname_part]
+  #   * length: 1..20 per part [sent to #dirname_part]
+  #
+  # @returns [String] a directory name
+  #
+  def dirname(options = {})
+    pathname = Pathname.new("/")
+    parts = options[:parts] || rand(2..6)
+    parts.times.each{ pathname += dirname_part(options) }
+    pathname.to_s
+  end
+
+  # Fab a directory path part e.g. "mydir".
+  #
+  # Options:
+  #
+  #  * chars: a..z
+  #  * size: rand(1..20)
+  #
+  # @returns [String] a directory name part
+  #
+  def dirname_part(options = {})
+    (options[:chars] || AZ).sample(options[:size] || rand(1..20)).join
+  end
+
+  # Fab a file extension.
+  # Delegates to #basename_extension.
+  #
+  # @returns [String] a file extension e.g. "txt"
+  #
+  # TODO refactor this to streamline it
+  #
+  def file_extension(options = {})
+    basename_extension(options)
+  end
+
+  # Fab a file path.
+  # Delegates to #path.
+  #
+  # @returns [String] a file path e.g. "/mydir1/mydir2/myfile.txt"
+  #
+  # TODO refactor this to streamline it
+  #
+  def file_path(options = {})
+    path(options)
+  end
+
+end