madlibs 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1125a3c5ba72d78edcea246293d14d836d734924
-  data.tar.gz: a0f62fba8126f03873912664f19342cd9bace812
+  metadata.gz: 50e1725db43dffc6104a7a07115b23f7f61cdefa
+  data.tar.gz: 684394e817d9405bcaf0d05b46716e4962a56f34
 SHA512:
-  metadata.gz: b0c7095bd644e9aadd88641e892bf9100d0b4a2cb6987fa391f253b8a1e51373806f23f8d99b1a3d7f7f0f169c61d98f3c094c3c01a08d84833129dd8b9158e3
-  data.tar.gz: fff04cdde7b252c459eb0320ce152fed065cf0497aece0337644dcb79b5d222f1cd11ebfef3e62456901bd47d7525fc3d7265eebdad79151ba6dd7ba82a209f0
+  metadata.gz: ced0191503cb29e9dd03b06c978b4b2807cd4c264ac40d671e8a3263b96329d4cd14b95d329ff8ffefde9deeffc98be29259c277205b2711cb73d572e174a363
+  data.tar.gz: 6cfe7a0a5d96f166bfbdb3b190895d1e66cf9e41d9a8e4b3c0d2330adf6a48bcb6b672bd060ba082712c3124c1d9e10576dd5b6cffba176ce1626778ce6416cc

data/README.md

@@ -1,8 +1,5 @@
 # Madlibs
 
-Sometimes you just need to make something silly on a whim.  That's exactly
-what this gem is and does.
-
 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.
 
@@ -86,33 +83,30 @@ interchangeable words.
 ```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",
-  ]
-
-})
+# Create a new Madlib object, passing a template and a dictionary.  You can also
+# pass nothing and assign them after the fact with `.dictionary` and `.template`
+madlib = Madlibs::Madlib.new(
+  'I will <verb> (the|another)( <adjective>)? <noun>',
+  {
+    "nouns" => [
+      "proxy",
+      "cache",
+      "architecture",
+      "fragmentation",
+    ],
+    "verbs" => [
+      "refactor",
+      "implement",
+      "replicate",
+      "debug",
+    ],
+    "adjectives" => [
+      "distributed",
+      "imperative",
+      "virtualized",
+    ]
+  }
+)
 
 # Generate your string(s)
 

data/lib/madlibs/dictionary.rb

@@ -0,0 +1,19 @@
+module Madlibs
+  class Dictionary
+
+    def initialize hash
+      # deep clone to prevent side-effects
+      @hash = Marshal.load(Marshal.dump(hash))
+      @hash_clone = Marshal.load(Marshal.dump(hash))
+    end
+
+    def retrieve type
+      return '' if @hash[type].nil? or @hash[type].empty?
+      @hash[type].delete @hash[type].sample
+    end
+
+    def reload
+      @hash = Marshal.load(Marshal.dump(@hash_clone))
+    end
+  end
+end

data/lib/madlibs/madlib.rb

@@ -1,65 +1,30 @@
 require 'active_support/inflector'
+require 'madlibs/template'
+require 'madlibs/dictionary'
 
 module Madlibs
   class Madlib
+    attr_accessor :template
+    attr_reader   :dictionary
 
-    def initialize template, dictionary = nil
-      @template = template
-      unless dictionary.nil?
-        @dictionary = dictionary.clone
-        @original_dictionary = dictionary.clone
-      end
+    def initialize template = '', dictionary_hash = {}
+      self.template = template
+      self.dictionary = dictionary_hash
     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]*\)/)
+    def dictionary=(hash)
+      @dictionary = Dictionary.new hash
     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}?", ''
+      @dictionary.reload
+      Template.process_word_lists(
+        Template.process_optionals(
+          Template.keys(@template).reduce(@template) do |temp, key|
+            Template.process_key temp, key, @dictionary.retrieve(key.pluralize)
           end
-        end
-      end
-
-      extract_keys(product).each do |key|
-        product.sub! "<#{key}>", retrieve(key)
-      end
-
-      product
+        )
+      )
     end
   end
 end

data/lib/madlibs/template.rb

@@ -0,0 +1,34 @@
+module Madlibs
+  module Template
+
+    def self.keys template
+      template.scan(/<([^>]*?)>/).map do |key|
+        key.first
+      end
+    end
+
+    def self.process_key template, key, value
+      template.sub "<#{key}>", value
+    end
+
+    def self.process_word_lists template
+      template.scan(/\([|a-zA-Z]*\)/).reduce(template) do |temp, words|
+        temp.sub words, words.gsub(/[()]/, '').split('|').sample
+      end
+    end
+
+    def self.process_optionals template
+      loop do
+        optionals = template.scan(/\([^\(]*?\)(?=\?)/)
+        break if optionals.empty?
+        template = optionals.reduce(template) do |temp, opt|
+          temp.sub(
+            "#{opt}?",
+            if [true, false].sample then opt.gsub(/[()]/, '') else '' end
+          )
+        end
+      end
+      template
+    end
+  end
+end

data/lib/madlibs/version.rb

@@ -1,3 +1,3 @@
 module Madlibs
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/madlibs.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/jondavidjohn/madlibs"
   spec.license       = "Apache v2"
 
   spec.files         = `git ls-files`.split($/)

data/specs/dictionary_spec.rb

@@ -0,0 +1,62 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'madlibs'
+
+describe Madlibs::Dictionary do
+  describe '#retrieve' do
+    it 'should retrieve a random dictionary term in a given collection' do
+      hash = {
+        'things' => [
+          'thing_one',
+          'thing_two',
+        ],
+        'items' => [
+          'item_one',
+          'item_two',
+          'item_three',
+        ]
+      }
+
+      dictionary = Madlibs::Dictionary.new(hash)
+      hash['things'].must_include dictionary.retrieve 'things'
+      hash['items'].must_include dictionary.retrieve 'items'
+    end
+
+    it 'should retrieve random dictionary items only once' do
+      dictionary = Madlibs::Dictionary.new({
+        'items' => [
+          'item_one',
+          'item_two',
+          'item_three',
+        ]
+      })
+
+      retrieved = []
+      retrieved.push dictionary.retrieve 'items'
+      retrieved.push dictionary.retrieve 'items'
+      retrieved.push dictionary.retrieve 'items'
+
+      retrieved.size.must_be_same_as retrieved.uniq.size
+    end
+
+    it 'should retrieve empty string from empty dictionary collection' do
+      dictionary = Madlibs::Dictionary.new({ 'items' => [ ] })
+      dictionary.retrieve('items').must_equal ''
+    end
+
+    it 'should not mutate the provided hash'do
+      hash = {
+        'items' => [
+          'item_one',
+          'item_two',
+          'item_three',
+        ]
+      }
+
+      dictionary = Madlibs::Dictionary.new(hash)
+      dictionary.retrieve 'items'
+      dictionary.retrieve 'items'
+      hash['items'].size.must_equal 3
+    end
+  end
+end

data/specs/madlib_spec.rb

@@ -3,66 +3,50 @@ require 'minitest/autorun'
 require 'madlibs'
 
 describe Madlibs::Madlib do
-  def assert_block(test_description, &block)
-    assert test_description, yield
-  end
-
-  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)'
+  describe 'generate' do
+    it 'should work' do
+      madlib = Madlibs::Madlib.new(
+        '(wow, )?such <noun>,( very <adjective>,)? so <verb>',
+        {
+          'nouns' => [
+            'desk',
+            'lamp',
+          ],
+          'adjectives' => [
+            'neat',
+            'fun',
+          ],
+          'verbs' => [
+            'commit',
+            'scare',
+          ]
+        }
+      )
+
+      [ 'such lamp, very neat, so commit',
+        'wow, such lamp, very fun, so commit',
+        'wow, such desk, very neat, so scare',
+        'such desk, so scare',
+        'wow, such lamp, so scare',
+        'wow, such desk, very neat, so commit',
+        'wow, such desk, very fun, so commit',
+        'such desk, very neat, so commit',
+        'wow, such desk, very fun, so scare',
+        'such lamp, very fun, so commit',
+        'wow, such desk, so commit',
+        'such lamp, so commit',
+        'such desk, so commit',
+        'such lamp, very fun, so scare',
+        'wow, such desk, so scare',
+        'wow, such lamp, so commit',
+        'such lamp, very neat, so scare',
+        'wow, such lamp, very fun, so scare',
+        'such lamp, so scare',
+        'wow, such lamp, very neat, so scare',
+        'such desk, very fun, so scare',
+        'such desk, very neat, so scare',
+        'wow, such lamp, very neat, so commit',
+        'such desk, very fun, so commit' ].must_include madlib.generate
     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

data/specs/template_spec.rb

@@ -0,0 +1,68 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'madlibs'
+
+describe Madlibs::Template do
+  describe '#keys' do
+    it 'should extract simple keys' do
+      keys = Madlibs::Template.keys '<simple> <keys>'
+      keys.size.must_equal 2
+      keys.must_include 'simple'
+      keys.must_include 'keys'
+    end
+
+    it 'should extract keys from more complex templates' do
+      keys = Madlibs::Template.keys '<simple> (some|words) (<keys>)?'
+      keys.size.must_equal 2
+      keys.must_include 'simple'
+      keys.must_include 'keys'
+    end
+  end
+
+  describe '#process_key' do
+    it 'should put a value in place of a key' do
+      result = Madlibs::Template.process_key '<simple> <keys>', 'simple', 'hello'
+      result.must_equal 'hello <keys>'
+    end
+  end
+
+  describe '#process_word_lists' do
+    it 'should choose random words from word lists included in a template' do
+      result = Madlibs::Template.process_word_lists '(simple) (simple|word|lists)'
+      [ 'simple simple',
+        'simple word',
+        'simple lists' ].must_include result
+    end
+
+    it 'should choose random words from word lists included in a complex template' do
+      result = Madlibs::Template.process_word_lists '<simple> (some|words) (<keys>)? (to|extract)'
+      [ '<simple> some (<keys>)? to',
+        '<simple> some (<keys>)? extract',
+        '<simple> words (<keys>)? to',
+        '<simple> words (<keys>)? extract' ].must_include result
+    end
+  end
+
+  describe '#process_optionals' do
+    it 'should choose to randomly include optional elements' do
+      result = Madlibs::Template.process_optionals 'this is( really)?( very)? silly'
+      [ 'this is really very silly',
+        'this is very silly',
+        'this is really silly',
+        'this is silly' ].must_include result
+    end
+
+    it 'should choose to randomly include optional elements in complex templates' do
+      result = Madlibs::Template.process_optionals '<simple> (some|words)( <keys>)? (to|extract)'
+      [ '<simple> (some|words) <keys> (to|extract)',
+        '<simple> (some|words) (to|extract)' ].must_include result
+    end
+
+    it 'should support the nesting of optionals' do
+      result = Madlibs::Template.process_optionals 'this is( very( freaking)?)? cool'
+      [ 'this is cool',
+        'this is very cool',
+        'this is very freaking cool' ].must_include result
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madlibs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonathan D. Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-16 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,11 +65,15 @@ files:
 - README.md
 - Rakefile
 - lib/madlibs.rb
+- lib/madlibs/dictionary.rb
 - lib/madlibs/madlib.rb
+- lib/madlibs/template.rb
 - lib/madlibs/version.rb
 - madlibs.gemspec
+- specs/dictionary_spec.rb
 - specs/madlib_spec.rb
-homepage: ''
+- specs/template_spec.rb
+homepage: https://github.com/jondavidjohn/madlibs
 licenses:
 - Apache v2
 metadata: {}