madlibber 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d49e0ec33b6ea532c5be38b5d2e8d2c503bd702a
4
+ data.tar.gz: 00fc0cb5c6b52cbe1ba72a875032ba9df98d6d3d
5
+ SHA512:
6
+ metadata.gz: c5e4643ea8c949a0b74deb07f4f086e6260ebdf106e9df71626e9cdc76845c3e5f24abc7523d250da5cbbd7e82176f1154a4c1d6c35805f84f2580f3335955ab
7
+ data.tar.gz: 7addb0c2e0a54c3b7250ca104d9bb03cbffc46a161803b0221b6419e9e1fd9b279207a55fe444c6960dcb8804e5a87834ac4a042f58965be2d7b38a6e4897bab
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in madlibber.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Steven Miyakawa SAM
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,51 @@
1
+ # MadLibber
2
+
3
+ TODO: Write a gem description
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'madlibber'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install madlibber
18
+
19
+ ## Usage
20
+ ```ruby
21
+ require 'madlibber'
22
+
23
+ text = "At Indiegogo you’ll find a welcoming, supportive community that embraces collaboration, fearlessness and authenticity. We are a a rapidly growing organization and our platform is used by people all over the world to raise money for their creative, cause-related, or entrepreneurial ideas. Our customers are passionate about their funding campaigns, and so are we! We are a team of passionate, results-driven, team-players who are lucky enough to be able to call “helping people achieve their dream” work. We love our dogs, good food, coffee, and post-it notes! Lots of post-it notes!"
24
+
25
+ MadLibber.libberfy text
26
+ ```
27
+
28
+ By default, it generates a Mad Lib with 10 fillable fields if 10 fillable fields are available. The following example illustrates how you could specify how many fillable fields that you would like:
29
+
30
+ ```ruby
31
+ require 'madlibber'
32
+
33
+ text = "At Indiegogo you’ll find a welcoming, supportive community that embraces collaboration, fearlessness and authenticity. We are a a rapidly growing organization and our platform is used by people all over the world to raise money for their creative, cause-related, or entrepreneurial ideas. Our customers are passionate about their funding campaigns, and so are we! We are a team of passionate, results-driven, team-players who are lucky enough to be able to call “helping people achieve their dream” work. We love our dogs, good food, coffee, and post-it notes! Lots of post-it notes!"
34
+
35
+ MadLibber.libberfy text, { num_of_blanks: 15 }
36
+ ```
37
+
38
+ ## Available fillable fields
39
+ Right now the following fillable fields randomly populate the Mad Lib.
40
+
41
+ ```
42
+ <noun>, <plural_noun>, <proper_noun>, <verb>, <verb_past_tense>, <adjective>, <adverb> and <interjection>
43
+ ```
44
+
45
+ ## Contributing
46
+
47
+ 1. Fork it
48
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
49
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
50
+ 4. Push to the branch (`git push origin my-new-feature`)
51
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/lib/madlibber.rb ADDED
@@ -0,0 +1,53 @@
1
+ require "madlibber/version"
2
+ require "engtagger"
3
+
4
+ module MadLibber
5
+
6
+ extend self
7
+
8
+ OPTIONS = {
9
+ num_of_blanks: 10
10
+ }
11
+
12
+ TAGS = {
13
+ "NN" => "<noun>",
14
+ "NNS" => "<plural_noun>",
15
+ "NNP" => "<proper_noun>",
16
+ "VB" => "<verb>",
17
+ "VBD" => "<verb_past_tense>",
18
+ "JJ" => "<adjective>",
19
+ "RB" => "<adverb>",
20
+ "UH" => "<interjection>"
21
+ }
22
+
23
+ def libberfy text, options = OPTIONS
24
+ defaults = OPTIONS
25
+ defaults.merge! options
26
+ tgr = EngTagger.new
27
+ tag_word_pairs = tgr.get_readable(text).split.map { |tagged_word| create_tag_word_pairs tagged_word }
28
+ fillable_indices = find_fillable_indices(tag_word_pairs).shuffle.take defaults[:num_of_blanks]
29
+
30
+ tag_word_pairs.map.with_index do |tw_pair, index|
31
+ (fillable_indices.include? index) ? TAGS[ tw_pair[:tag] ] : tw_pair[:word]
32
+ end.join(" ")
33
+ end
34
+
35
+ def create_tag_word_pairs word
36
+ index = ( word =~ /\/\S*$/ )
37
+ tag = word[(index + 1)..-1]
38
+ word = word[0..(index - 1)]
39
+ { word: word, tag: tag }
40
+ end
41
+
42
+ def find_fillable_indices tag_word_pairs
43
+ fillable_indices = tag_word_pairs.map.with_index do |tw_pair, index|
44
+ fillable_tag = TAGS[ tw_pair[:tag] ]
45
+ fillable_tag ? index : nil
46
+ end.compact!
47
+
48
+ fillable_indices ? fillable_indices : []
49
+ end
50
+
51
+ end
52
+
53
+
@@ -0,0 +1,3 @@
1
+ module Madlibber
2
+ VERSION = "0.0.1"
3
+ end
data/madlibber.gemspec ADDED
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'madlibber/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "madlibber"
8
+ spec.version = Madlibber::VERSION
9
+ spec.authors = ["Sam Samskies"]
10
+ spec.email = ["samprofessional@gmail.com"]
11
+ spec.description = %q{Turns any chunk of text into a Mad Lib.}
12
+ spec.summary = %q{Turns any chunk of text into a Mad Lib}
13
+ spec.homepage = "https://github.com/SamSamskies/madlibber"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.3"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "pry"
24
+ spec.add_dependency "engtagger"
25
+ end
metadata ADDED
@@ -0,0 +1,108 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: madlibber
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Sam Samskies
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-01-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.3'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: pry
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: engtagger
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Turns any chunk of text into a Mad Lib.
70
+ email:
71
+ - samprofessional@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - .gitignore
77
+ - Gemfile
78
+ - LICENSE.txt
79
+ - README.md
80
+ - Rakefile
81
+ - lib/madlibber.rb
82
+ - lib/madlibber/version.rb
83
+ - madlibber.gemspec
84
+ homepage: https://github.com/SamSamskies/madlibber
85
+ licenses:
86
+ - MIT
87
+ metadata: {}
88
+ post_install_message:
89
+ rdoc_options: []
90
+ require_paths:
91
+ - lib
92
+ required_ruby_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - '>='
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ required_rubygems_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - '>='
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ requirements: []
103
+ rubyforge_project:
104
+ rubygems_version: 2.2.1
105
+ signing_key:
106
+ specification_version: 4
107
+ summary: Turns any chunk of text into a Mad Lib
108
+ test_files: []