phil 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a097c29022da4d95864025def83c24f921fbdec6
+  data.tar.gz: d0d9c026d74181fb0f0dae4f6c787620706132f5
+SHA512:
+  metadata.gz: 01f07b15c56601616045ae7ea1923520006552701b0f31d1e6b92a124a7f899e507dd4d07be9bdd1a013c18766446268f4c37f72182ca58405415ab48a9368cf
+  data.tar.gz: 2fad59da69815f4b515c9d99c1045371b0f326355bfcb4070a8ef6275b9e213260eb7e6769ea0afccfc2d1ee132b73f0ced53bea12a3ab016cde4103483ecea7

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Cameron Daigle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,92 @@
+# Phil
+
+Phil is a lightweight content generation module that wraps around [Ffaker](https://github.com/EmmanuelOga/ffaker/tree/master/lib/ffaker). You can create large amounts of markup for layout testing with a few simple methods.
+
+A big theme of Phil is that any parameter that can accept a number also accepts a range. This allows for far more utility than vanilla Ffaker when it comes to testing different permutations of content.
+
+## Iteration
+
+Get a random integer from an array or range:
+
+```ruby
+Phil.pick 1..3
+Phil.pick [1, 2, 3]
+Phil.pick ["Foo", "Bar", "Baz"]
+```
+
+Loop a random number of times:
+
+```ruby
+Phil.loop 1..100 do |i|
+  "This will be output between 1 and 100 times and is index #{i}"
+end
+```
+
+Have a 1 in N chance of doing something (N defaults to 3):
+
+```ruby
+Phil.sometimes "foo"                    # 1 in 3
+Phil.sometimes "foo", 100               # 1 in 100
+Phil.sometimes do
+  "foo"
+Phil.sometimes 100 do
+  "foo"
+```
+
+## Content Generation
+
+### Body content
+
+Generate a ton of body content with one method. This defaults to
+`"h1 p p h2 p ol h2 p ul"`, but you can pass it a string of whatever content tags you like,
+including `blockquote`, other headings, and so on. Blockquotes will contain multiple `<p>` elements, paragraphs will contain a few sentences, and most other tags will contain 3-15 words.
+
+```ruby
+Phil.body_content
+Phil.body_content "h1 p h2 ul p blockquote h5 h6"
+```
+
+### Lorem methods (all take ranges or numbers)
+
+```ruby
+Phil.words 5
+Phil.words 5..50
+
+Phil.paragraphs 5                       # outputs HTML markup with <p> elements
+Phil.paragraphs 5..50
+
+Phil.blockquote                         # defaults to containing 1..3 <p> elements
+Phil.blockquote 1..5                    # 1..5 <p> elements
+
+Phil.ul                                 # defaults to 3..10 <li>s with 3..15 words
+Phil.ul 1..5, 10                        # 1..5 items, 10 words apiece
+
+Phil.ol
+Phil.ol 1..5, 10
+
+Phil.link_list                          # outputs a <ul> of <li>s with <a>s inside
+Phil.link_list 1..5, 10
+```
+
+### Assorted other content generation methods
+
+```ruby
+Phil.date                               # Random date object between Dec 31 1969 and now
+Phil.date 7                             # Random date object in the last 7 days
+Phil.currency 10..100                   # Price string from $10.00 to $100.00
+Phil.currency 10..100, "£"              # Prefix different currency symbol
+Phil.phone                              # Defaults to (###)-###-####
+Phil.phone "###-#### x###"
+Phil.number 5                           # Random 5-digit number (string)
+```
+
+### Aliased Ffaker methods for convenience
+
+```ruby
+Phil.domain_name
+Phil.email
+Phil.name
+Phil.first_name
+Phil.last_name
+Phil.state_abbr
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/phil/version.rb

@@ -0,0 +1,3 @@
+module Phil
+  VERSION = '0.9.1'
+end

data/lib/phil.rb

@@ -0,0 +1,132 @@
+module Phil
+
+  class << self
+
+    def pick(num)
+      num.respond_to?(:to_a) ? num.to_a.sample : num
+    end
+
+    def loop(num)
+      pick(num).times do |i|
+        yield(i)
+      end
+    end
+
+    def sometimes(num_or_content = 3, num = 3)
+      if block_given?
+        if num_or_content == pick(1..num_or_content)
+          yield
+        end
+      else
+        if num == pick(1..num)
+          num_or_content
+        end
+      end
+    end
+
+    def words(num)
+      Faker::Lorem.words(pick(num)).join(' ').html_safe
+    end
+
+    def paragraphs(num)
+      content_method = -> { Faker::Lorem.paragraphs(1).join }
+      build_tags "p", content_method, pick(num)
+    end
+
+    def ul(list_items = nil, item_length = nil)
+      tag "ul", item_length, list_items
+    end
+
+    def ol(list_items = nil, item_length = nil)
+      tag "ol", item_length, list_items
+    end
+
+    def blockquote(paragraphs = nil)
+      tag "blockquote", paragraphs
+    end
+
+    def link_list(list_items = (3..10), item_length = (1..5))
+      build_tag "ul", build_tags("li", -> { "<a href='#'>#{words(item_length)}</a>" }, list_items)
+    end
+
+    def body_content(pattern="h1 p p h2 p ol h2 p ul")
+      pattern.split(" ").map{ |t| tag(t) }.join.html_safe
+    end
+
+    def currency(num, symbol = "$")
+      val = ((pick(num) * 100) / 100).round(2)
+      sprintf("$%.2f", val)
+    end
+
+    def number(length)
+      (1..length).map { rand(10) }.join
+    end
+
+    def date(day_window = nil)
+      t = Time.now.to_f
+      Time.at(day_window ? t - rand * day_window * 86400 : t * rand)
+    end
+
+    def domain_name
+      Faker::Internet.domain_name
+    end
+
+    def email
+      Faker::Internet.email
+    end
+
+    def first_name
+      Faker::Name.first_name
+    end
+
+    def last_name
+      Faker::Name.last_name
+    end
+
+    def name
+      Faker::Name.name
+    end
+
+    def phone(format = "(###) ###-####")
+      format.gsub(/#/) { rand(9) + 1 }
+    end
+
+    def state
+      Faker::AddressUS.state
+    end
+
+    def state_abbr
+      Faker::AddressUS.state_abbr
+    end
+
+    private
+
+    def tag(name, content = nil, children = nil)
+      case name
+        when "ul", "ol"
+          content ||= (3..15)
+          children ||= (3..10)
+          build_tag name, build_tags("li", content, children)
+        when "blockquote"
+          content ||= (1..3)
+          build_tag name, paragraphs(content)
+        when "p"
+          paragraphs(1)
+        else
+          content ||= (3..15)
+          build_tags name, content
+      end
+    end
+
+    def build_tags(name, content, elements = 1)
+      content_method = if content.is_a? Proc then content else -> { words(content) } end
+      pick(elements).times.map { build_tag(name, content_method.call) }.join.html_safe
+    end
+
+    def build_tag(name, content)
+      "<#{name}>#{content}</#{name}>".html_safe
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: phil
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Cameron Daigle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Phil makes it easy to generate content for your UI mockups.
+email:
+- cameron@hashrocket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/phil/version.rb
+- lib/phil.rb
+- LICENSE
+- README.md
+- Rakefile
+homepage: https://github.com/camerond/phil
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Phil brings the content.
+test_files: []