spicy-proton 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49b487f3156db9335ce1f187af57d5e8877455a3
-  data.tar.gz: c25cc5744f2b6e8c985fe28001299d7452d7ddcd
+  metadata.gz: 28481edad03c822b978caa8f1555f6a7ecb93083
+  data.tar.gz: 50ee9d4827eb08a40798078fb36940b7ba567995
 SHA512:
-  metadata.gz: 5959e524ba6b0ab94cf5abff8b73770c4b6ea11730593c6fbf7443a658e846f6bc7d8bb8e2403596207f40852b8c7122415e469e223c5ce495417936403b2cc1
-  data.tar.gz: 44431d50963f269729df64554a208b1ab147c58f4f98d8aeb29a42243629237af3c0fcf8649f0d5a66a964240ac1c6f751beebaeaaaa63a10e684d76c9399b4c
+  metadata.gz: fdb6e19b9b443858792846853693f1d7ab3e3b2bd3a43e8d131e92857d640cceddd01121393e4cc00f1aef75e24b5f242a51938a33f4605261ca5270c466e447
+  data.tar.gz: 491b27d08194a110a0bd1840cc51533f3fabf3c0f0037ab5ba70d006d64ba7a019579319cd6c986940bc7f91003ce776afeb85ff5cdaeb7111bc72c51ad0e281

data/README.md

@@ -1,4 +1,5 @@
 # Spicy::Proton
+
 Generate a random English adjective-noun word pair. Works with Ruby 1.9.x and newer.
 
 [![Gem Version](https://badge.fury.io/rb/spicy-proton.svg)](http://rubygems.org/gems/spicy-proton)
@@ -26,13 +27,18 @@ Spicy::Proton.adjective             # => "extreme"
 Spicy::Proton.noun                  # => "loan"
 Spicy::Proton.pair                  # => "opportune-spacesuit"
 Spicy::Proton.pair(':')             # => "hip:squash"
+Spicy::Proton.adverb                # => "energetically"
+Spicy::Proton.verb                  # => "refrained"
 Spicy::Proton.format('%a/%a/%n')    # => "dapper/festive/fedora"
+Spicy::Proton.format('%b %v')       # => "artfully stained"
 
 # With length constraints.
 Spicy::Proton.adjective(max: 5)     # => "dank"
 Spicy::Proton.noun(min: 10)         # => "interpolation"
 Spicy::Proton.adjective(length: 8)  # => "medieval"
 Spicy::Proton.noun(min: 5, max: 7)  # => "dolphin"
+Spicy::Proton.adverb(min: 0)        # => "prophetically"
+Spicy::Proton.verb(max: 100)        # => "sparkles"
 ```
 
 When generating multiple specimens, instance methods are faster. The instance keeps the word corpus in memory. The instance methods are the same as their class method counterparts.
@@ -40,23 +46,31 @@ When generating multiple specimens, instance methods are faster. The instance ke
 ```ruby
 require 'spicy-proton'
 
-generator = Spicy::Proton.new
+gen = Spicy::Proton.new
 1000.times do 
-  generator.adjective
-  generator.noun(min: 7)
-  generator.pair
-  generator.pair('.')
-  generator.format('%a-%n')
+  gen.adjective
+  gen.noun(min: 7)
+  gen.pair
+  gen.pair('.')
+  gen.adverb(length: 6)
+  gen.verb(max: 5)
+  gen.format('The %a %n %b %v the %n.')
 end
 ```
 
-Instances give you access to the raw word lists as well:
+Instances also provide raw word lists in length order:
 
 ```ruby
-generator.adjectives    # => ["dreadful", "methodist", "necessary", "tough", ...]
-generator.nouns         # => ["rustling", "fiance", "infield", "chatter", ...]
+gen.adjectives    # => ["aft", "apt", "bad", "big", ...]
+gen.nouns         # => ["ad", "ax, "ox", "pi", ...]
+gen.adverbs       # => ["no", "aft", "ago", "all", ...]
+gen.verbs         # => ["am", "be", "do", "go", ...]
 ```
 
+## Credits
+
+Inspired by [btford/adj-noun](https://github.com/btford/adj-noun). Thanks to [NLTK](http://www.nltk.org/) for the word corpus.
+
 ## License
 
 Copyright © 2017 Chris Schmich  

data/lib/corpus.rb

@@ -0,0 +1,40 @@
+module Spicy
+  module Corpus
+    def adjective(*args)
+      generate(:adjectives, *args)
+    end
+
+    def noun(*args)
+      generate(:nouns, *args)
+    end
+
+    def verb(*args)
+      generate(:verbs, *args)
+    end
+
+    def adverb(*args)
+      generate(:adverbs, *args)
+    end
+
+    def pair(separator = '-')
+      "#{adjective}#{separator}#{noun}"
+    end
+
+    def format(format)
+      format.gsub(/%([anbv%])/) do
+        case $1
+        when 'a'
+          adjective
+        when 'n'
+          noun
+        when 'b'
+          adverb
+        when 'v'
+          verb
+        when '%'
+          '%'
+        end
+      end
+    end
+  end
+end

data/lib/disk-corpus.rb

@@ -1,22 +1,20 @@
-require 'yaml'
 require 'seek'
 require 'header'
+require 'corpus'
 
 module Spicy
 end
 
 module Spicy::Disk
   module Files
+    @@files = {}
+
     def self.dir
       @@dir ||= File.join(File.dirname(__FILE__), 'corpus')
     end
 
-    def self.adjectives
-      @@adjectives ||= File.join(dir, 'adjectives-fixed.bin')
-    end
-
-    def self.nouns
-      @@nouns ||= File.join(dir, 'nouns-fixed.bin')
+    def self.corpus(type)
+      @@files[type] ||= File.join(dir, "#{type}-fixed.bin")
     end
   end
 
@@ -25,11 +23,9 @@ module Spicy::Disk
 
     def initialize(file_name)
       @file = File.open(file_name, 'rb')
-
       @cumulative = Spicy::Header.cumulative(@file)
       @min = @cumulative.keys.min
       @max = @cumulative.keys.max
-
       @origin = @file.pos
     end
 
@@ -46,6 +42,8 @@ module Spicy::Disk
   end
   
   class Corpus
+    include Spicy::Corpus
+
     private_class_method :new
 
     def self.use
@@ -65,19 +63,11 @@ module Spicy::Disk
       @lists.values.each(&:close)
     end
 
-    def adjective(*args)
-      generate(:adjectives, *args)
-    end
-
-    def noun(*args)
-      generate(:nouns, *args)
-    end
-
     private
 
     def generate(type, *args)
       @lists[type] ||= begin
-        WordList.new(Files.send(type))
+        WordList.new(Files.corpus(type))
       end
       @lists[type].word(*args)
     end

data/lib/memory-corpus.rb

@@ -1,22 +1,20 @@
-require 'yaml'
 require 'seek'
 require 'header'
+require 'corpus'
 
 module Spicy
 end
 
 module Spicy::Memory
   module Files
+    @@files = {}
+
     def self.dir
       @@dir ||= File.join(File.dirname(__FILE__), 'corpus')
     end
 
-    def self.adjectives
-      @@adjectives ||= File.join(dir, 'adjectives.bin')
-    end
-
-    def self.nouns
-      @@nouns ||= File.join(dir, 'nouns.bin')
+    def self.corpus(type)
+      @@files[type] ||= File.join(dir, "#{type}.bin")
     end
   end
 
@@ -37,25 +35,45 @@ module Spicy::Memory
         @words[index]
       end
     end
+
+    def words
+      @words
+    end
   end
 
   class Corpus
+    include Spicy::Corpus
+
     def initialize
-      dir = File.dirname(__FILE__)
-      @adjectives = WordList.new(Files.adjectives)
-      @nouns = WordList.new(Files.nouns)
+      @lists = {}
+    end
+
+    def adjectives
+      list(:adjectives).words
+    end
+
+    def nouns
+      list(:nouns).words
     end
 
-    def adjective(*args)
-      @adjectives.word(*args)
+    def adverbs
+      list(:adverbs).words
     end
 
-    def noun(*args)
-      @nouns.word(*args)
+    def verbs
+      list(:verbs).words
     end
 
-    def pair(separator = '-')
-      "#{self.adjective}#{separator}#{self.noun}"
+    private
+
+    def generate(type, *args)
+      list(type).word(*args)
+    end
+
+    def list(type)
+      @lists[type] ||= begin
+        WordList.new(Files.corpus(type))
+      end
     end
   end
 end

data/lib/spicy-proton.rb

@@ -6,53 +6,20 @@ module Spicy
   class Proton
     extend Forwardable
 
-    def initialize
-      @corpus = Memory::Corpus.new
-    end
-
-    def self.adjective(*args)
-      Disk::Corpus.use do |c|
-        c.adjective(*args)
-      end
-    end
-
-    def self.noun(*args)
-      Disk::Corpus.use do |c|
-        c.noun(*args)
-      end
-    end
-
-    def self.pair(separator = '-')
-      Disk::Corpus.use do |c|
-        "#{c.adjective}#{separator}#{c.noun}"
-      end
-    end
-
-    def self.format(format)
-      Disk::Corpus.use do |c|
-        self.format_with(c, format)
+    class << self
+      [:adjective, :noun, :adverb, :verb, :pair, :format].each do |method|
+        define_method(method) do |*args, &block|
+          Disk::Corpus.use do |c|
+            c.send(method, *args, &block)
+          end
+        end
       end
     end
 
-    def format(format)
-      self.class.format_with(self, format)
+    def initialize
+      @corpus = Memory::Corpus.new
     end
 
-    def_delegators :@corpus, :adjective, :noun, :pair, :adjectives, :nouns
-
-    private
-
-    def self.format_with(source, format)
-      format.gsub(/%([an%])/) do
-        case $1
-        when 'a'
-          source.adjective
-        when 'n'
-          source.noun
-        when '%'
-          '%'
-        end
-      end
-    end
+    def_delegators :@corpus, :adjective, :noun, :adverb, :verb, :adjectives, :nouns, :adverbs, :verbs, :pair, :format
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spicy-proton
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Schmich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -46,10 +46,15 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/corpus.rb
 - lib/corpus/adjectives-fixed.bin
 - lib/corpus/adjectives.bin
+- lib/corpus/adverbs-fixed.bin
+- lib/corpus/adverbs.bin
 - lib/corpus/nouns-fixed.bin
 - lib/corpus/nouns.bin
+- lib/corpus/verbs-fixed.bin
+- lib/corpus/verbs.bin
 - lib/disk-corpus.rb
 - lib/header.rb
 - lib/memory-corpus.rb
@@ -75,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Generate a random English adjective-noun word pair.