glueckskeks 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8d596fe9089e8325ffdda0c275925c96df62946
-  data.tar.gz: e76338be2e23856908d413b9a2528c5a2a753dcf
+SHA256:
+  metadata.gz: 35776ff5d4ad9e9ee99f89eb12bade8e7d931bd56bb1776ead124d2c3e6afd43
+  data.tar.gz: 9602d4f151f178c0ec382a8a3e9e572516293ec573b800ea2e66b8e471d5fa9a
 SHA512:
-  metadata.gz: 91215a0d6b09e922b73d9d7b6106868e48a09795624453c05fd2c2c759cfabe6d3228f64fec859100d7722595ed769a8e6692d1cd690d256184feb387775916c
-  data.tar.gz: d984b3216a4b6c19fff24fb31d03ac6f034517cefb424db94f5b5383cf9f59c4788ab0946c9d013207ba4933bffe7b665662a0959013469cad4a25b8b96ea59d
+  metadata.gz: 7d356831577a396c218aa7a6ad269ba41bf5b6d42584f1fa169d277972f2e32407301a1d7410dbd33b702c1fb4213666504054ec38413ade762e439c994c9ac8
+  data.tar.gz: a1455eff941a54c79b8be1e3c0844e9149b78553413c405745167e851756dc4ecdd11d43bb818032e19ce84a3df8a6961bc7421ca5e1d00c8177a711eb069fed

data/README.md

@@ -1,10 +1,10 @@
 # Glueckskeks
 
-Use 'corpus' files specified in `corpus/` to create random phrases (or other things).
+Use 'corpus' files specified in `corpus/` to create random phrases (or other things) on the command line.
 
 To experiment with that code, run `bin/console` for an interactive prompt.
 
-Licensed under the GPLv3+ (see the `COPYING` file included) , Copyright 2017 Felix Wolfsteller.
+Licensed under the GPLv3+ (see the `COPYING` file included) , Copyright 2017,2019 Felix Wolfsteller.
 
 ## Installation
 
@@ -38,7 +38,7 @@ dog
 ```
 
 . That example should show that there are three files, `corpus/base.corpus`, `corpus/adj.corpus` and `corpus/noun.corpus` with the respective content.
-The `base.corpus` file will be read first and stuff in dangerous brackets (`<stuff>`) will be replaced by **one of the values of the respective file** (`corpus/stuff.corpus`, or in the example above, `adj.corpus` and `noun.corpus` respectively.  Note that thes "variable"-names do not include the file ending `.corpus`.
+The `base.corpus` file will be read first and stuff in dangerous brackets (`<stuff>`) will be replaced by **one of the values (== lines) of the respective file** (`corpus/stuff.corpus`, or in the example above, `adj.corpus` and `noun.corpus` respectively).  Note that thes "variable"-names do not include the file ending `.corpus`.
 
 To produce a random selection, execute `glueckskeks` (depending on your setup this might be `bundle exec exe/glueckskeks`), e.g.
 
@@ -48,11 +48,26 @@ black cat
 -> bc
 ```
 
-The last line will be your phrase in passwordish-abbreviation.
+The last line ("bc" in that example) will be your phrase in passwordish-abbreviation.
+
+Note that the starting node ('base') and the directory where the corpus files are located can be changed.  Run `glueckskeks --help` to get this or a similar output:
+
+    $ glueckskeks --help
+    Usage: exe/glueckskeks
+    
+    Generate phrase from files (default: in corpus/).
+    
+        -b, --base=BASE                  Start extension from BASE file (default: 'base')
+        -c, --corpus=DIRECTORY           Read .corpus files from DIRECTORY (default: './corpus')
+        -d, --debug                      Print debug messages to STDOUT
+            --[no-]capitalize            Capitalize first letter of output (default: true)
+        -h, --help                       Show this help and exit.
+            --version                    Show version and exit.
+
 
 ## "Gluckskeks" wtf - where are the vowels
 
-"Glueckskeks" is the German term for the wisdom-containing thing that you get served e.g. in chinese restaurants (in Germany).
+"Glueckskeks" is the German term for the wisdom-containing thing that you get served e.g. in chinese restaurants (in Germany).  Like, remember the internet-meme "That wasn't chicken"".
 
 ## Development
 

data/exe/glueckskeks

@@ -3,7 +3,7 @@
 require 'glueckskeks'
 require 'optparse'
 
-options = {corpus: 'corpus', base: 'base'}
+options = {corpus: 'corpus', base: 'base', capitalize: true}
 
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME}"
@@ -14,12 +14,15 @@ optparse = OptionParser.new do |opts|
   opts.on('-b', '--base=BASE', 'Start extension from BASE file (default: \'base\')') do |b|
     options[:base] = b
   end
-  opts.on('-c', '--corpus=DIRECTORY', 'Read .corpus files from DIRECTORY (default: \'./corpus\'') do |c|
+  opts.on('-c', '--corpus=DIRECTORY', 'Read .corpus files from DIRECTORY (default: \'./corpus\')') do |c|
     options[:corpus] = c
   end
   opts.on('-d', '--debug', 'Print debug messages to STDOUT') do |d|
     options[:debug] = d
   end
+  opts.on('--[no-]capitalize', 'Capitalize first letter of output (default: true)') do |c|
+    options[:capitalize] = c
+  end
   opts.on_tail('--version', 'Show version and exit.') do
     puts "#{$PROGRAM_NAME} #{Glueckskeks::VERSION}"
     exit 0
@@ -33,5 +36,12 @@ end.parse!
 Glueckskeks.logger.level = options[:debug] ? Logger::DEBUG : Logger::INFO
 
 phrase = Glueckskeks.generate(options[:corpus], options[:base])
+if options[:capitalize]
+  phrase = phrase[0].upcase + phrase[1..-1]
+end
+
 puts phrase
 puts Glueckskeks::Collapser.collapse(phrase)
+
+# Leave the stage with grace.
+exit 0

data/glueckskeks.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/glueckskeks/corpus_reader.rb

@@ -1,5 +1,7 @@
 module Glueckskeks
   class CorpusReader
+    # Returned "Corpus"" is a map from a name (originating from filename)
+    # to the lines of that file
     def self.read_corpus_files(corpus_dir='corpus')
       result_map = {}
 

data/lib/glueckskeks/substitutor.rb

@@ -6,8 +6,8 @@ module Glueckskeks
         if !(corpus.has_key? type)
           Glueckskeks.logger.error "No corpus entry for #{type} found"
         end
-        replace_with =  corpus[type].sample
-        str.gsub!("\<#{type}\>", replace_with)
+        replace_with = corpus[type].sample
+        str.sub!("\<#{type}\>", replace_with)
       end
       str
     end

data/lib/glueckskeks/templater.rb

@@ -1,5 +1,6 @@
 module Glueckskeks
   class Templater
+    # param @tmpl can contain variables (like "<word> <sign>")
     def self.fill(tmpl, corpus)
       orig_tmpl = tmpl.dup
       while (tmpl=Substitutor.replace(tmpl, corpus)) != orig_tmpl

data/lib/glueckskeks/version.rb

@@ -1,3 +1,3 @@
 module Glueckskeks
-  VERSION = "0.1.1"
+  VERSION = "0.1.2".freeze
 end

data/lib/glueckskeks.rb

@@ -19,13 +19,14 @@ module Glueckskeks
   def self.generate(corpus_dir='corpus', entry='base')
     @corpus = CorpusReader.read_corpus_files(corpus_dir)
     if @corpus && @corpus.empty?
-      STDERR.puts "Empty corpus, are any data files present in ./corpus ?"
+      STDERR.puts "Empty corpus, are any data files present in ./corpus/ ?"
       exit 1
     end
     if @corpus[entry].nil? || @corpus[entry].empty?
       STDERR.puts "Corpus does not contain a base (corpus/base.corpus) file, or it does not contain any patterns."
       exit 2
     end
+    # Start with a line from entry corpus
     Templater.fill(@corpus[entry].sample, @corpus)
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: glueckskeks
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Felix Wolfsteller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
@@ -97,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Use grammar(ish) files to create random phrases.