word_tally 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ad3839063c426520a6ca9adca2f1ff3121524788e6bbbf3bd7c88eeca8c09cb
+  data.tar.gz: 90b03da8789104dde63ea26723dbe0010b0ed7d7383cec04a581d40c65c0cab3
+SHA512:
+  metadata.gz: eadd0010fc80a61c7a50174074f4b72d1a3df3de17ead595686c4baa7de81a612637f0a7919a63a347de6b9f6fc650822aed5baba7872c9b5ad7c316ed5fb467
+  data.tar.gz: c17d955c7c134b80cacc754d04b9b197fb546cb6c03188f635d2a8099c9c299f75345eed82a48a82f38ae0c4f91dcf84dd78ddd0606d03a3e6a230f92ec42b23

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 9
+
+Style/Alias:
+  EnforcedStyle: prefer_alias
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumberedParametersLimit:
+  Max: 9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Shannon Skipper
+
+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/README.md

@@ -0,0 +1,35 @@
+# WordTally
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/word_tally`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/word_tally.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/word-tally

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'word_tally'
+require 'word_tally/args'
+
+options = ARGV.options do |cli|
+  cli.banner = <<~BANNER
+    Output a tally of the number of times unique words appear in source input.
+
+    \u001b[4mUsage:\u001b[0m word-tally [OPTIONS] [INPUT]
+
+    \u001b[4mArguments:\u001b[0m
+      [INPUT]  File path to use as input rather than stdin ("-") [default: -]
+
+    \u001b[4mOptions:\u001b[0m
+  BANNER
+  cli.version = WordTally::VERSION
+  cli.accept(Symbol, &:to_sym)
+
+  cli.on '-s', '--sort=ORDER', 'Sort order [default: desc] [possible values: desc, asc, unsorted]', Symbol
+  cli.on '-c', '--case=FORMAT', 'Case normalization [default: lower] [possible values: original, upper, lower]', Symbol
+  cli.on '-m', '--min_chars=COUNT', 'Exclude words that contain fewer than min chars [default: 1]', Integer
+  cli.on '-M', '--min_count=COUNT', 'Exclude words that appear fewer than min times [default: 1]', Integer
+  cli.on '-D', '--delimiter=VALUE', 'Delimiter between keys and values [default: " "]', String
+  cli.on '-o', '--output=PATH', 'Write output to file rather than stdout', String
+  cli.on '-v', '--verbose', 'Print verbose details'
+  cli.on '-d', '--debug', 'Print debugging information'
+  cli.on '-h', '--help', 'Print help' do
+    puts cli
+    exit
+  end
+  cli.on '-V', '--version', 'Print version' do
+    puts cli.ver
+  end
+end
+
+args = WordTally::Args.new
+options.parse!(into: args)
+
+input = if ARGV.empty?
+          $stdin
+        else
+          File.open(ARGV.shift)
+        end
+
+word_tally = WordTally.new(
+  input,
+  format: args.case,
+  order: args.sort,
+  min_chars: args.min_chars,
+  min_count: args.min_count
+)
+
+delimiter = args.delimiter
+
+if args.verbose
+  warn "total-words#{delimiter}#{word_tally.count}"
+  warn "uniq-words#{delimiter}#{word_tally.uniq_count}"
+end
+
+if args.debug
+  warn "delimiter#{delimiter}#{delimiter}"
+  warn "case#{delimiter}#{args.case}"
+  warn "order#{delimiter}#{args.sort}"
+  warn "min-chars#{delimiter}#{args.min_chars}"
+  warn "min-count#{delimiter}#{args.min_count}"
+  warn "verbose#{delimiter}#{args.verbose}"
+  warn "debug#{delimiter}#{args.debug}"
+end
+
+tally = word_tally.tally
+
+warn("\n") if (args.verbose || args.debug) && tally.any?
+
+output = args.output
+
+if output
+  File.open output, 'w' do |file|
+    tally.each do |word, count|
+      file << "#{word}#{delimiter}#{count}\n"
+    end
+  end
+else
+  tally.each do |word, count|
+    puts "#{word}#{delimiter}#{count}"
+  end
+end

data/lib/word_tally/args.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class WordTally
+  class Args
+    attr_accessor :sort, :case, :min_chars, :min_count, :delimiter, :output, :verbose, :debug
+
+    def initialize(sort: :desc, word_case: :lower, min_chars: 1, min_count: 1, delimiter: ' ', output: nil,
+                   verbose: false, debug: false)
+      @sort = sort
+      @case = word_case
+      @min_chars = min_chars
+      @min_count = min_count
+      @delimiter = delimiter
+      @output = output
+      @verbose = verbose
+      @debug = debug
+    end
+
+    def []=(attribute, value)
+      instance_variable_set("@#{attribute}", value)
+    end
+  end
+end

data/lib/word_tally/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class WordTally
+  VERSION = '0.1.0'
+end

data/lib/word_tally.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'word_tally/version'
+
+class WordTally
+  attr_reader :tally, :count, :uniq_count, :avg
+
+  def initialize(input, format: :lower, order: :desc, min_chars: 1, min_count: 1)
+    tally_map = tally_map(input, format, min_chars)
+    tally_map.filter! { |_word, count| count >= min_count } if min_count > 1
+    @count = tally_map.values.sum
+    @tally = tally_map.to_a
+    @uniq_count = @tally.size
+    @avg = @count.positive? && @count.fdiv(@uniq_count)
+
+    sort(order)
+  end
+
+  def sort(order)
+    case order
+    in :desc
+      @tally.sort_by! { |_word, count| -count }
+    in :asc
+      @tally.sort_by! { |_word, count| count }
+    in :unsorted
+      nil
+    end
+  end
+
+  private
+
+  def tally_map(input, format, min_chars)
+    tally = Hash.new(0)
+
+    input.each_line(chomp: true) do |line|
+      words = normalize(line, format).split(/\b/).grep(/[[:alnum:]]/)
+      words.filter! { |word| word.size >= min_chars } if min_chars > 1
+
+      words.each { |word| tally[word] += 1 }
+    end
+
+    tally
+  end
+
+  def normalize(text, format)
+    case format
+    in :lower
+      text.downcase
+    in :upper
+      text.upcase
+    in :original
+      text
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: word_tally
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shannon Skipper
+bindir: bin
+cert_chain: []
+date: 2024-06-06 00:00:00.000000000 Z
+dependencies: []
+description: Output a tally of the number of times unique words appear in file or
+  stdin source.
+email:
+- shannonskipper@gmail.com
+executables:
+- word-tally
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- bin/word-tally
+- lib/word_tally.rb
+- lib/word_tally/args.rb
+- lib/word_tally/version.rb
+homepage: https://github.com/havenwood/word_tally
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Tallies the count of words from a file or streamed input.
+test_files: []