story_key 0.3.0 → 0.4.0

data/lib/story_key/image_generator.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+require 'open-uri'
+require 'rmagick'
+require 'ruby/openai'
+
+class StoryKey::ImageGenerator < StoryKey::Base
+  BG_COLOR = '#ffffff'
+  CAPTION_FONT_SIZE = 15
+  CAPTION_HEIGHT = 30
+  DALLE_SIZE = 512
+  FONT_PATH = File.expand_path('assets/BarlowSemiCondensed-Regular.ttf')
+  ERROR_IMAGE = File.expand_path('assets/error.png')
+  OUTPUT_PATH = File.expand_path('tmp/story-key.png')
+  FOOTER_FONT_SIZE = 17
+  FOOTER_HEIGHT = 30
+  HEADER_FONT_SIZE = 17
+  PANEL_SIZE = 350
+  PADDING = 10
+  STYLE = 'isometric art with white background'
+
+  option :seed
+  option :phrases
+
+  def call
+    return if openai_key.blank?
+    composite_image
+  end
+
+  private
+
+  def comp_width
+    num_cols = phrases.size > 1 ? 2 : 1
+    (PANEL_SIZE * num_cols) + (PADDING * (num_cols + 1))
+  end
+
+  def comp_height
+    num_rows = (phrases.size.to_f / 2).ceil
+    (PANEL_SIZE * num_rows) + (PADDING * (num_rows + 1)) + header_height + FOOTER_HEIGHT
+  end
+
+  def header_height
+    (multiline_seed.split("\n").size * HEADER_FONT_SIZE).ceil
+  end
+
+  def multiline_seed
+    seed.split
+        .each_slice(8)
+        .to_a
+        .map { |a| a.join(' ') }
+        .join("\n")
+  end
+
+  def composite_image
+    comp = image_background
+    comp = add_header(comp)
+    comp = add_panels(comp)
+    comp = add_footer(comp)
+    comp.write(OUTPUT_PATH)
+    delete_source_images
+    OUTPUT_PATH
+  end
+
+  def delete_source_images
+    image_paths.each { |path| FileUtils.rm_f(path) }
+  end
+
+  def add_panels(comp)
+    image_paths.each_slice(2).to_a.each_with_index do |row, row_idx|
+      row.each_with_index do |image_path, col_idx|
+        comp = add_panel(comp, image_path, row.size, row_idx, col_idx)
+      end
+    end
+    comp
+  end
+
+  def add_panel(comp, image_path, row_size, row_idx, col_idx)
+    y = header_height + (PANEL_SIZE * row_idx) + (PADDING * (row_idx + 2))
+    if row_size == 1 # Center the last image if it has no pair
+      gravity = Magick::NorthGravity
+      x = 0
+    else
+      gravity = Magick::NorthWestGravity
+      x = (PANEL_SIZE * col_idx) + (PADDING * (col_idx + 2))
+    end
+    img = Magick::ImageList.new(image_path)
+    comp.composite(img, gravity, x, y, Magick::OverCompositeOp)
+  end
+
+  def image_background
+    Magick::Image.new(comp_width, comp_height) do |m|
+      m.background_color = BG_COLOR
+    end
+  end
+
+  def image_paths
+    @image_paths ||= phrases.each_with_index.map do |phrase, idx|
+      response = dalle_client.images.generate(parameters: parameters(phrase))
+      error = response.dig('error', 'message')
+      image_url = response.dig('data', 0, 'url')
+      text = "#{idx + 1}. #{phrase}"
+      local_image_path(image_url, text, error.present?)
+    end
+  end
+
+  def local_image_path(image_url, phrase, error)
+    source_path, destination_path = panel_paths(error, image_url)
+    comp = Magick::ImageList.new(source_path)
+    comp.change_geometry!("#{PANEL_SIZE}x#{PANEL_SIZE}") do |cols, rows, img|
+      img.resize!(cols, rows)
+    end
+    caption_bg = Magick::Image.new(PANEL_SIZE, CAPTION_HEIGHT) { |m| m.background_color = BG_COLOR }
+    comp = comp.composite(caption_bg, Magick::SouthGravity, 0, 0, Magick::OverCompositeOp)
+    add_caption(comp, phrase)
+    comp.write(destination_path)
+    destination_path
+  end
+
+  def panel_paths(error, image_url)
+    if error
+      [ERROR_IMAGE, "#{SecureRandom.hex(10)}.png"]
+    else
+      local = local_image(image_url)
+      Array.new(2) { local }
+    end
+  end
+
+  def add_header(comp)
+    add_annotation(comp, multiline_seed, Magick::NorthGravity, 5)
+  end
+
+  def add_caption(comp, text)
+    offset = ((CAPTION_HEIGHT - CAPTION_FONT_SIZE).to_f / 2).ceil
+    add_annotation(comp, text, Magick::SouthGravity, offset)
+  end
+
+  def add_footer(comp)
+    text = "Made with StoryKey - #{StoryKey::GITHUB_URL}"
+    add_annotation(comp, text, Magick::SouthGravity, 10)
+  end
+
+  def add_annotation(comp, text, gravity, offset)
+    draw = Magick::Draw.new
+    comp.annotate(draw, 0, 0, 0, offset, text) do
+      draw.gravity = gravity
+      draw.pointsize = CAPTION_FONT_SIZE
+      draw.fill = '#000000'
+      draw.font = FONT_PATH
+      comp.format = 'png'
+    end
+    comp
+  end
+
+  def local_image(image_url)
+    filename = image_url.split('?').first.split('/').last
+    path = File.expand_path("tmp/#{filename}")
+    File.open(path, 'wb') do |file|
+      file << URI.parse(image_url).open.read
+    end
+    path
+  end
+
+  def parameters(phrase)
+    prompt = "#{phrase}, #{STYLE}"
+    { prompt:, size: "#{DALLE_SIZE}x#{DALLE_SIZE}" }
+  end
+
+  def openai_key
+    @openai_key ||= ENV.fetch('OPENAI_KEY', nil)
+  end
+
+  def dalle_client
+    @dalle_client ||= OpenAI::Client.new(access_token: openai_key)
+  end
+end

data/lib/story_key/{generator.rb → key_generator.rb}

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-class StoryKey::Generator < StoryKey::Base
+class StoryKey::KeyGenerator < StoryKey::Base
   option :bitsize, default: -> {}
   option :format, default: -> {}
 
@@ -13,7 +13,11 @@ class StoryKey::Generator < StoryKey::Base
   private
 
   def formatted_str
-    StoryKey::Coercer.call(str: random_bin, bitsize:, from: :bin, to: format)
+    StoryKey::Coercer.call(str:, bitsize:, from: :bin, to: format)
+  end
+
+  def str
+    "1#{random_bin}"[0, bitsize]
   end
 
   def random_bin

data/lib/story_key/lexicon.rb

@@ -28,9 +28,9 @@ class StoryKey::Lexicon < StoryKey::Base
 
   def new_entry(part_of_speech, text, countable)
     StoryKey::Entry.new \
+      part_of_speech:,
       raw: text,
       text: text.gsub(/\[|\]/, ''),
-      part_of_speech:,
       token: StoryKey::Tokenizer.call(text),
       countable:,
       preposition: text.match(/\[(.+)\]/).to_a[1]

data/lib/story_key/tokenizer.rb

@@ -11,7 +11,7 @@ class StoryKey::Tokenizer < StoryKey::Base
   def token_from_text
     text.downcase
         .gsub(/\[.+\]/, '')
-        .gsub(/[^a-z0-9\s\-]/, '')
+        .gsub(/[^a-z0-9\s-]/, '')
         .strip
         .gsub(/\s+/, '-')
   end

data/lib/story_key/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module StoryKey
-  VERSION = '0.3.0'
-  VERSION_SLUG = 'Miami' # Name of a well-known place, no spaces
-  LEXICON_SHA = '4eea29f'
+  VERSION = '0.4.0'
+  VERSION_SLUG = 'Miami' # Name of a well-known city, no spaces
+  LEXICON_SHA = '3bfbbf9'
 end

data/lib/story_key.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/string/inflections'
 require 'awesome_print'
 require 'base58'
 require 'digest'
+require 'dotenv/load'
 require 'dry-initializer'
 require 'indefinite_article'
 require 'pry'
@@ -19,7 +20,7 @@ loader.setup
 module StoryKey
   BITS_PER_ENTRY = 10
   DEFAULT_BITSIZE = 256
-  FOOTER_BITSIZE = 4 # StoryKey::BITS_PER_ENTRY <= 2^StoryKey::FOOTER_BITSIZE
+  FOOTER_BITSIZE = 4 # StoryKey::BITS_PER_ENTRY must be lte 2^StoryKey::FOOTER_BITSIZE
   FORMATS = %i[base58 hex bin dec].freeze
   GRAMMAR = {
     4 => %i[adjective noun verb noun],
@@ -30,10 +31,10 @@ module StoryKey
   LEXICON_SHA_SIZE = 7
   MAX_BITSIZE = 512
   PREPOSITIONS = %w[in i saw and a an].freeze
+  GITHUB_URL = 'https://github.com/jcraigk/storykey'
 
-  Entry = Struct.new \
-    :raw, :token, :text, :countable, :preposition, :part_of_speech, keyword_init: true
-  Story = Struct.new(:text, :humanized, :tokenized, keyword_init: true)
+  Entry = Struct.new(:part_of_speech, :raw, :token, :text, :countable, :preposition)
+  Story = Struct.new(:phrases, :text, :humanized, :tokenized)
 
   class Error < StandardError; end
   class InvalidFormat < Error; end

data/rakelib/lexicon.rake

@@ -1,6 +1,34 @@
 # frozen_string_literal: true
 require_relative '../lib/story_key'
 
+def noun_entries
+  { countable: [], uncountable: [] }.tap do |data|
+    Dir.glob('lexicons/nouns/**/*.txt') do |path|
+      group = path.split('/')[-2] == 'countable' ? :countable : :uncountable
+      data[group] += txtfile_lines(path)
+    end
+    data.each { |group, entries| data[group] = entries.sort }
+  end
+end
+
+def verb_entries
+  { entries: txtfile_lines('lexicons/verbs/entries.txt') }
+end
+
+def adjective_entries
+  entries = []
+  Dir.glob('lexicons/adjectives/*.txt') do |path|
+    entries += txtfile_lines(path)
+  end
+  { entries: entries.sort }
+end
+
+def txtfile_lines(path)
+  File.readlines(path)
+      .map(&:strip)
+      .reject { |l| l.start_with?('#') || l.blank? }
+end
+
 namespace :lexicon do
   desc 'Build lib/story_key/data.rb from text files'
   task :build do
@@ -17,15 +45,15 @@ namespace :lexicon do
       TEXT
     str += [].tap do |ary|
       StoryKey::GRAMMAR.values.flatten.uniq.each do |part_of_speech|
-        substr = "  #{part_of_speech}: {\n"
+        substr = "    #{part_of_speech}: {\n"
         substr +=
           [].tap do |ary2|
-            entries_for(part_of_speech).each do |group, entries|
+            send("#{part_of_speech}_entries").each do |group, entries|
               elements = entries.map { |e| "'#{e}'" }.join(', ')
-              ary2 << "   #{group}: [#{elements}]"
+              ary2 << "      #{group}: [#{elements}]"
             end
           end.join(",\n")
-        ary << "#{substr}\n  }"
+        ary << "#{substr}\n    }"
       end
     end.join(",\n")
     str +=
@@ -37,20 +65,4 @@ namespace :lexicon do
     File.write(output_file, str)
     puts "#{output_file} written"
   end
-
-  def entries_for(part_of_speech)
-    { countable: [], uncountable: [] }.tap do |data|
-      Dir.glob("lexicons/#{part_of_speech}s/**/*.txt") do |path|
-        group = path.split('/')[-2] == 'countable' ? :countable : :uncountable
-        data[group] += txtfile_lines(path)
-      end
-      data.each { |group, entries| data[group] = entries.sort }
-    end
-  end
-
-  def txtfile_lines(path)
-    File.readlines(path)
-        .map(&:strip)
-        .reject { |l| l.start_with?('#') || l.blank? }
-  end
 end

data/story_key.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Justin Craig-Kuhn (JCK)']
   spec.email         = ['jcraigk@gmail.com']
   spec.summary       = 'StoryKey turns your crypto private key into a memorable story'
-  spec.homepage      = 'https://github.com/jcraigk/story_key'
+  spec.homepage      = 'https://github.com/jcraigk/storykey'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_ruby_version = '>= 3.2.0'
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -17,21 +17,24 @@ Gem::Specification.new do |spec|
     f.match(%r{^(spec)/})
   end
 
-  spec.add_dependency 'activesupport', '~> 7.0.2'
+  spec.add_dependency 'activesupport', '~> 7.0.4'
   spec.add_dependency 'awesome_print', '~> 1.9.2'
   spec.add_dependency 'base58', '~> 0.2.3'
+  spec.add_dependency 'dotenv', '~> 2.8.1'
   spec.add_dependency 'dry-initializer', '~> 3.1.1'
-  spec.add_dependency 'indefinite_article', '~> 0.2.4'
+  spec.add_dependency 'indefinite_article', '~> 0.2.5'
   spec.add_dependency 'pry', '~> 0.14.1'
   spec.add_dependency 'remedy', '~> 0.3.0'
+  spec.add_dependency 'rmagick', '~> 5.1.0'
+  spec.add_dependency 'ruby-openai', '~> 3.0.2'
   spec.add_dependency 'thor', '~> 1.2.1'
-  spec.add_dependency 'zeitwerk', '~> 2.5.4'
+  spec.add_dependency 'zeitwerk', '~> 2.6.6'
 
-  spec.add_development_dependency 'bundler', '~> 2.3.7'
+  spec.add_development_dependency 'bundler', '~> 2.4.1'
   spec.add_development_dependency 'rake', '~> 13.0.6'
-  spec.add_development_dependency 'rspec', '~> 3.11.0'
-  spec.add_development_dependency 'rubocop', '~> 1.26.1'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.13.3'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'rubocop', '~> 1.41.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.15.2'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.16.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: story_key
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Craig-Kuhn (JCK)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.2
+        version: 7.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.2
+        version: 7.0.4
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +170,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: 2.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: 2.6.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.7
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.7
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,42 +212,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.41.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.3
+        version: 1.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.3
+        version: 1.15.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +268,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.16.0
 description:
 email:
 - jcraigk@gmail.com
@@ -241,7 +283,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -252,6 +293,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/BarlowSemiCondensed-Regular.ttf
+- assets/error.png
 - bin/console
 - bin/setup
 - bin/storykey
@@ -269,7 +312,7 @@ files:
 - lexicons/nouns/uncountable/misc_characters.txt
 - lexicons/nouns/uncountable/simpsons_characters.txt
 - lexicons/nouns/uncountable/starwars_characters.txt
-- lexicons/verbs/misc.txt
+- lexicons/verbs/entries.txt
 - lib/story_key.rb
 - lib/story_key/base.rb
 - lib/story_key/class_methods.rb
@@ -279,13 +322,15 @@ files:
 - lib/story_key/data.rb
 - lib/story_key/decoder.rb
 - lib/story_key/encoder.rb
-- lib/story_key/generator.rb
+- lib/story_key/image_generator.rb
+- lib/story_key/key_generator.rb
 - lib/story_key/lexicon.rb
 - lib/story_key/tokenizer.rb
 - lib/story_key/version.rb
 - rakelib/lexicon.rake
 - story_key.gemspec
-homepage: https://github.com/jcraigk/story_key
+- tmp/.keep
+homepage: https://github.com/jcraigk/storykey
 licenses:
 - MIT
 metadata: {}
@@ -297,14 +342,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: StoryKey turns your crypto private key into a memorable story