madlibs 1.0.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+Gemfile.lock
+*.rbc
+.bundle
+.config
+.ruby-version
+.rvmrc
+bin/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,149 @@
+# Madlibs
+
+Sometimes you just need to make something silly on a whim.  That's exactly
+what this is.
+
+This gem simply takes a template, does some randomizing, applies a dictionary,
+and produces a string.  Depending on the dictionary, it can be quite humorous.
+
+## Usage
+
+### The Dictionary
+
+The dictionary is a simple ruby hash with keyed arrays of words, but there are
+a few rules.
+
+  1. Make sure your keys are plural
+
+Ok, so maybe there is just that one.
+
+### The Template
+
+The template has 3 main syntax entities
+
+#### Keys
+
+Very simply, `<key>` signifies it to do a random replace from the correlated
+dictionary, the name of the key is arbitrary as long as it is singular in the
+template and plural in the dictionary.
+
+For example `<key>` would match the `keys` dictionary hash key.
+
+You are ensured that you won't get the same word twice in a single generation.
+
+#### Optionals
+
+Wrapping any segment of text in parenthesis immediately followed by a `?` will
+make the generation randomly include or exclude the inner text.  And yes, they
+can be nested.
+
+```rb
+"This is a(n example)? template."
+```
+
+Will result in either
+
+```rb
+"This is a template."
+```
+
+or
+
+```rb
+"This is an example template."
+```
+
+#### Word Lists
+
+Lastly, for another element of randomness, you can provide a word list that it
+will choose from at random.
+
+```rb
+"This is a (great|terrible) example."
+```
+
+Will result in either
+
+```rb
+"This is a great example."
+```
+
+or
+
+```rb
+"This is a terrible example."
+```
+
+This can be useful for creating more entropy from a set of common small
+interchangeable words.
+
+```rb
+"(the|a|some|one)"
+```
+
+### Full Example
+
+```rb
+require 'madlibs'
+
+# Create a new Madlib object, passing a template
+madlib = Madlibs::Madlib.new 'I will <verb> (the|another)( <adjective>)? <noun>'
+
+# Load your desired dictionary
+madlib.load({
+
+  "nouns" => [
+    "proxy",
+    "cache",
+    "architecture",
+    "fragmentation",
+  ],
+
+  "verbs" => [
+    "refactor",
+    "implement",
+    "replicate",
+    "debug",
+  ],
+
+  "adjectives" => [
+    "distributed",
+    "imperative",
+    "virtualized",
+  ]
+
+})
+
+# Generate your string(s)
+
+madlib.generate
+# => "I will debug the architecture"
+
+madlib.generate
+# => "I will implement another imperative cache"
+
+madlib.generate
+# => "I will refactor another virtualized proxy"
+```
+
+## Installation
+
+**Not yet distributed via rubygems yet.**
+
+Add this line to your application's Gemfile:
+
+    gem 'madlibs'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install madlibs
+
+## Development
+
+    rake test
+    rake build
+    rake install

data/Rakefile

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'bundler'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rake/clean'
+
+CLOBBER.include 'pkg/*'
+CLEAN.include 'pkg/*'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['specs/*_spec.rb']
+  t.verbose = false
+end
+
+task :default => [:test, :clobber, :build]

data/lib/madlibs.rb

@@ -0,0 +1,5 @@
+require 'madlibs/version'
+require 'madlibs/madlib'
+
+module Madlibs
+end

data/lib/madlibs/madlib.rb

@@ -0,0 +1,65 @@
+require 'active_support/inflector'
+
+module Madlibs
+  class Madlib
+
+    def initialize template, dictionary = nil
+      @template = template
+      unless dictionary.nil?
+        @dictionary = dictionary.clone
+        @original_dictionary = dictionary.clone
+      end
+    end
+
+    def load dictionary
+      @original_dictionary = dictionary.clone
+      @dictionary = dictionary.clone
+    end
+
+    def reload
+      @dictionary = @original_dictionary.clone
+    end
+
+    def retrieve type
+      types = type.pluralize
+      @dictionary[types].delete @dictionary[types].sample
+    end
+
+    def extract_keys template
+      template.scan(/<([^>]*?)>/).flatten
+    end
+
+    def extract_word_lists template
+      template.scan(/\([|a-zA-Z]*\)/)
+    end
+
+    def generate
+      reload
+
+      product = @template.clone
+
+      extract_word_lists(product).each do |words|
+        product.gsub! words, words.gsub(/[()]/, '').split('|').sample
+      end
+
+      loop do
+        optionals = product.scan(/\([^\(]*?\)(?=\?)/)
+        break unless optionals.any?
+        optionals.each do |o|
+          if [true, false].sample
+            used_string = o.gsub(/[()]/, '')
+            product.sub! "#{o}?", used_string
+          else
+            product.sub! "#{o}?", ''
+          end
+        end
+      end
+
+      extract_keys(product).each do |key|
+        product.sub! "<#{key}>", retrieve(key)
+      end
+
+      product
+    end
+  end
+end

data/lib/madlibs/version.rb

@@ -0,0 +1,3 @@
+module Madlibs
+  VERSION = "1.0.0"
+end

data/madlibs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'madlibs/version'
+require 'date'
+
+Gem::Specification.new do |spec|
+  spec.name          = "madlibs"
+  spec.version       = Madlibs::VERSION
+  spec.authors       = ["Jonathan D. Johnson"]
+  spec.email         = ["me@jondavidjohn.com"]
+  spec.description   = %q{Because sometimes, you just need to make something stupid.}
+  spec.summary       = %q{Create generated text with a combination of coditional templating and a provided dictionary}
+  spec.homepage      = ""
+  spec.license       = "Apache v2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "active_support", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/specs/madlib_spec.rb

@@ -0,0 +1,65 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'madlibs'
+
+describe Madlibs::Madlib do
+
+  before do
+    @mad = Madlibs::Madlib.new '', {
+      "things" => [
+        "thing_one",
+        "thing_two",
+        "thing_three",
+      ],
+      "items" => [
+        "item_one",
+        "item_two",
+        "item_three",
+      ]
+    }
+  end
+
+  it "should accurately extract simple <keys>" do
+    keys = @mad.extract_keys('<simple> <keys>')
+    keys.size.must_equal 2
+    assert_block "correct keys extracted" do
+      keys.include? 'simple' and keys.include? 'keys'
+    end
+  end
+
+  it "should accurately extract <keys> with other templating entities around" do
+    keys = @mad.extract_keys('<simple> (some|words) (<keys>)?')
+    keys.size.must_equal 2
+    assert_block "correct keys extracted" do
+      keys.include? 'simple' and keys.include? 'keys'
+    end
+  end
+
+  it "should accurately extract simple (word|lists)" do
+    keys = @mad.extract_word_lists('(simple) (simple|word|lists)')
+    keys.size.must_equal 2
+    assert_block "correct lists extracted" do
+      keys.include? '(simple)' and keys.include? '(simple|word|lists)'
+    end
+  end
+
+  it "should accurately extract (word|lists) with other templating entities around" do
+    keys = @mad.extract_word_lists('<simple> (some|words) (<keys>)? (to|extract)')
+    keys.size.must_equal 2
+    assert_block "correct keys extracted" do
+      keys.include? '(some|words)' and keys.include? '(to|extract)'
+    end
+  end
+
+  it "should retrieve random dictionary items only once" do
+    retrieved = []
+    retrieved.push @mad.retrieve 'item'
+    retrieved.push @mad.retrieve 'item'
+    retrieved.push @mad.retrieve 'item'
+
+    retrieved.size.must_be_same_as retrieved.uniq.size
+
+    @mad.retrieve('item').must_be_nil
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: madlibs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan D. Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Because sometimes, you just need to make something stupid.
+email:
+- me@jondavidjohn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/madlibs.rb
+- lib/madlibs/madlib.rb
+- lib/madlibs/version.rb
+- madlibs.gemspec
+- specs/madlib_spec.rb
+homepage: ''
+licenses:
+- Apache v2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 937808861999979417
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 937808861999979417
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Create generated text with a combination of coditional templating and a provided
+  dictionary
+test_files: []