wordgraph 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eec332d565ac8fcf1192d04b99b9d6d313b68a2291dd44ce7532dfeccb42141
-  data.tar.gz: 2d2f2efa8e4d5747ed81ec6c1fa555df1dcf95e5970102b27c464340ddc50165
+  metadata.gz: 45813d9103ca02b5238dbfe12b4aa656da441dcbe66be0fac9e8e46f81b9744a
+  data.tar.gz: 21516d98f4aea705561d34c8a23835dc23df1d575369a0bc4a7cd225a863a7b3
 SHA512:
-  metadata.gz: d3009ff268b5ca9a58f9b98d82541834b95f885662e8a828c1c4a289109157bd452cbda69edcc3202fc6835607772e6ca0dfaec53cbeb628e567dea01fdc8a64
-  data.tar.gz: 1e71d6ec4dea81d0cfbd1e1738d25df072810a597408a10ebbc4bfa65fd39121a946229c8fdfe935deeae3d63a8682ae303f624c18d95d65b919cf06ab40113e
+  metadata.gz: 2170ee77edca8125943b3dac61aee6d0fed2a753b7d3456a7acadc5dd4cd61711663b8fc7c833f329eac5d3db8e9d1f83b2973f3e62bb8a29ad5a011e30df29b
+  data.tar.gz: b69f1a188c603e887e145720fd123db9397cb4bca03b6dbb2104b947c5ef351b175f6efd270cf8a7658b22fce68ace1f41194a5069f8079000269e529a23bdf9

data/.document

@@ -0,0 +1,5 @@
+lib/*.rb
+lib/**/*.rb
+-
+CHANGELOG.rdoc
+LICENSE.md

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "wordgraph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/wordgraph

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "wordgraph/cli"
+
+cli = Wordgraph::CLI.new
+options = cli.parse(ARGV)

data/lib/wordgraph/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "optparse"
+require_relative "core"
 
 module Wordgraph
   class CLI
@@ -10,27 +11,57 @@ module Wordgraph
 
     def parse(args)
       parser = OptionParser.new do |opts|
-        opts.banner = "Usage: cli.rb [options] ARG..."
+        opts.banner = "E.g.: wordgraph [options] ARG..."
         opts.separator ""
         opts.separator "Specific options:"
 
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          puts args
+        end
+        
         opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
           @options[:verbose] = v
         end
 
-        opts.on("-h", "--help", "Prints this help") do
-          puts opts
-          puts args
-          exit
+        opts.on("-o=STRING", "--output-directory=STRING", "Directory to output files", String) do |dir|
+          # Supports /mnt/[:drive_letter]/[:directory]
+          @options[:output_directory] = dir
+        end
+
+        opts.on("-n=STRING", "--name=STRING", "Output file name", String) do |name|
+          @options[:name] = name
+        end
+
+        opts.on("--[no-]overwrite", "Overwrite output file") do |overwrite|
+          @options[:overwrite] = overwrite
+        end
+
+        opts.on("-s=INTEGER", "--seed=INTEGER", "Deterministic word order", Integer) do |seed|
+          @options[:seed] = seed
+        end
+
+        opts.on("-m=INTEGER", "--nlargest=INTEGER", "Maximum amount of words in graph", Integer) do |nlargest|
+          @options[:nlargest] = nlargest
+        end
+
+        opts.on("--font=STRING", ["times", "georgia", "garamond", "arial", 
+                "helvetica", "verdana", "courier", "cursive", "papyrus"], 
+                "Use a web safe font", String) do |font|
+          @options[:font] = font
         end
       end
 
       begin
-        parser.parse!(args)
+        files = parser.parse!(args)
+        core = Core.new(files, **@options)
+        core.process
       rescue OptionParser::InvalidOption => e
         puts e.message
         puts parser
         exit 1
+      rescue ArgumentError => e
+        puts "Invalid argument: #{e}"
       end
 
       @options

data/lib/wordgraph/core.rb

@@ -0,0 +1,182 @@
+require_relative "mathwg"
+
+module Wordgraph
+  class Core
+    def initialize(files, verbose: false, output_directory: Dir.pwd, name: "wordgraph", 
+                    overwrite: false, seed: nil, nlargest: nil, font: "times")
+      @files = files
+      @verbose = verbose
+      @output_directory = output_directory
+      @name = name
+      @overwrite = overwrite
+      @seed = seed
+      @nlargest = nlargest
+      @max_size = 20
+      @min_font_size = 12;
+      @max_font_size = 48;
+      @font = font.downcase
+      if @verbose
+        puts "Proceeding with settings:"
+        self.instance_variables.each do |var|
+          puts "#{var}: #{self.instance_variable_get(var) || false}"
+        end  
+      end
+    end
+
+    def tokenize(word)
+      # Lowercase
+      word = word.downcase
+      # Strip trailing punctuation at word start
+      word = word.sub(/^[\.,;:!?'"`(\[\{<]+/, "")
+      # Strip trailing punctuation at word end
+      word = word.sub(/[\.,;:!?'"`)\]\}>]+$/, "")
+      return word
+    end
+
+    def generate_cloud(tokens)
+      # https://en.wikipedia.org/wiki/Tag_cloud
+      raise ArgumentError, "Empty tokens map" unless tokens.length > 0
+      # Linear normalization
+      # TODO: logarithmic function for larger texts
+      min_count = tokens.values.min
+      max_count = tokens.values.max
+      max_sub_min = [max_count - min_count, 1].max
+      tokens = tokens.max_by(@nlargest) { |v| v }.to_h if @nlargest
+      tokens.each do |token, count|
+        size = count <= min_count ? 
+                1 : 
+                ((@max_size * (count - min_count)) / max_sub_min).ceil 
+        tokens[token] = {
+          count: count,
+          size: size
+        }
+      end
+      self.write_html(tokens)
+    end
+
+    def get_path
+      raise ArgumentError, "Output directory: #{@output_directory} not found" if !Dir.exist?(@output_directory)
+      file_name = File.basename(@name) + ".html"
+      out = File.join(@output_directory, file_name)
+      puts "Creating file: #{out}"
+      stop_exists = File.exist?(out) && !@overwrite
+      raise ArgumentError, "Output file already exists, either overwrite or change the name" if stop_exists
+      return out
+    end
+
+    def remap(from_min, from_max, to_min, to_max, value)
+      def lerp(a, b, t)
+        return (1 - t) * a + b * t
+      end
+      def invLerp(a, b, v)
+        return a === b ? 0 : (v - a).to_f / (b - a)
+      end
+      return lerp(to_min, to_max, invLerp(from_min, from_max, value))
+    end
+
+    def write_html(tokens)
+      out = self.get_path
+      File.open(out, File::RDWR | File::CREAT) do |f|
+        f.flock(File::LOCK_EX)
+        f.truncate(0)
+        document_setup = <<~HTML
+          <!DOCTYPE html>
+          <html lang="en">
+          <head>
+              <meta charset="UTF-8">
+              <meta name="viewport" content="width=device-width, initial-scale=1.0">
+              <title>wordgraph</title>
+          </head>
+          <body>
+            #{tokens.to_a.shuffle(random: Random.new(*@seed)).map { |k, v|
+              fs = remap(1, @max_size, @min_font_size, @max_font_size, v[:size]).floor
+              title = "#{v[:count].to_s} occurrence #{(v[:count] > 1 ) ? "s" : ""}"
+              <<~HTML.strip
+                <span
+                    title='#{title}'
+                    style='font-size: #{fs}px;'
+                    aria-role='listitem'
+                    aria-label='#{title}'>#{k}</span>
+              HTML
+            }.join("\n\s\s")}
+          </body>
+          <style>
+            body {
+              display: flex;
+              flex-wrap: wrap;
+              gap: 8px;
+              justify-content: center;
+              background-color: #000;
+              color: #FFFFFF;
+              line-height: 1.6;
+              margin: 0;
+              padding: 20px;
+              font-family: #{@font};
+            }
+            span {
+              display: inline-block;
+              margin: 2px 6px;
+              padding: 4px 12px;
+              border-radius: 4px;
+            }
+          </style>
+          </html>
+        HTML
+        f.write(document_setup)
+      end
+      puts File.read(out) if @verbose
+    end
+
+    def process_lines(lines)
+      count = {}
+      count.default = 0
+      lines.each do |line|
+        line.split do |word|
+          tokenized = self.tokenize(word)
+          count[tokenized] += 1
+        end
+      end
+      begin
+        puts count if @verbose
+        self.generate_cloud(count)
+      rescue ArgumentError => e
+        raise e
+      else
+        puts "Succesfully finished processing" if @verbose
+      end
+      return count
+    end
+
+    def process_text(file)
+      puts "Processing txt file #{file}" if @verbose
+      lines = IO.readlines(file)
+      return self.process_lines(lines)
+    end
+
+    def process_docx(file)
+      require "zip"
+      puts "Processing docx file #{file}" if @verbose
+      binary = File.open(file, 'rb') { |f| f.read }
+      Zip::File.open_buffer(binary) do |zip|
+        doc = zip.find { |entry| entry.name == 'word/document.xml'}
+        text = doc.get_input_stream.read
+        # TODO: check if styling is supported
+        lines = text.scan(/(?<=<w:t>).+?(?=<\/w:t>)/)
+        return self.process_lines(lines)
+      end
+    end
+
+    def process
+      Array(@files).each do |f|
+        case f
+        when /\.(txt|text)\z/i
+          return self.process_text(f)
+        when /\.docx\z/i
+          return self.process_docx(f)
+        else
+          raise ArgumentError, "File type not supported."
+        end
+      end
+    end
+  end
+end

data/lib/wordgraph/mathwg.rb

@@ -0,0 +1,15 @@
+module Wordgraph
+  module Mathwg
+    def lerp(a, b, t)
+      (1 - t) * a + b * t
+    end
+
+    def invLerp(a, b, v)
+      a === b ? 0 : (v - a).to_f / (b - a)
+    end
+    
+    def remap(from_min, from_max, to_min, to_max, value)
+      lerp(to_min, to_max, invLerp(from_min, from_max, value))
+    end
+  end
+end

data/lib/wordgraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wordgraph
-  VERSION = "0.1.0"
+  VERSION = "0.6.0"
 end

data/lib/wordgraph.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "wordgraph/version"
+require_relative "wordgraph/cli"
 
 module Wordgraph
   class Error < StandardError; end

data/wordgraph.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+lib = File.expand_path("../lib/", __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require "wordgraph/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "wordgraph"
+  spec.version = Wordgraph::VERSION
+  spec.licenses = %w(MIT)
+  spec.authors = ["marm00"]
+  spec.email = [""]
+  spec.description = "Wordgraph"
+  spec.summary = spec.description
+  spec.homepage = "https://github.com/marm00/wordgraph"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/marm00/wordgraph/issues",
+    "changelog_uri" => spec.homepage,
+    "documentation_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/marm00/wordgraph/tree/main",
+    "wiki_uri" => spec.homepage,
+  }
+
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.files = %w(.document wordgraph.gemspec) + Dir["*.md", "bin/*", "lib/**/*.rb", "fixtures/**/*"]
+  spec.executables = %w(wordgraph)
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency "optparse", "~> 0.6.0"
+end

metadata

@@ -1,32 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: wordgraph
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - marm00
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
-dependencies: []
-executables: []
+date: 2025-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: Wordgraph
+email:
+- ''
+executables:
+- wordgraph
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".ruby-version"
-- LICENSE
+- ".document"
 - README.md
-- Rakefile
+- bin/console
+- bin/setup
+- bin/wordgraph
 - lib/wordgraph.rb
 - lib/wordgraph/cli.rb
+- lib/wordgraph/core.rb
+- lib/wordgraph/mathwg.rb
 - lib/wordgraph/version.rb
-- sig/wordgraph.rbs
+- wordgraph.gemspec
 homepage: https://github.com/marm00/wordgraph
-licenses: []
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/marm00/wordgraph
-  source_code_uri: https://github.com/marm00/wordgraph
+  bug_tracker_uri: https://github.com/marm00/wordgraph/issues
+  changelog_uri: https://github.com/marm00/wordgraph
+  documentation_uri: https://github.com/marm00/wordgraph
+  source_code_uri: https://github.com/marm00/wordgraph/tree/main
+  wiki_uri: https://github.com/marm00/wordgraph
 rdoc_options: []
 require_paths:
 - lib
@@ -43,5 +67,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Graphs from words.
+summary: Wordgraph
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.ruby-version

@@ -1 +0,0 @@
-3.4.1

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 marm00
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/sig/wordgraph.rbs

@@ -1,4 +0,0 @@
-module Wordgraph
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end