words_counted 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9834aaae70272cc358a8bd7f846b56077c94c322
-  data.tar.gz: 80a6bd1a780307da11adc85a267ae8ad77b60be3
+  metadata.gz: 190a90d67fb727203b2956402d95b3d830947ba9
+  data.tar.gz: 3af82b30917c67c6d8e0460461a87eccd311080d
 SHA512:
-  metadata.gz: e0089b2b4ef682901c65c01641fb6643e7d85c3bf13b2b14dbb1a6d99b4ddaf1c5c74f8e40c7fd1a3ba3af8d4229cec229df98c826499d690b8a7db012279fd9
-  data.tar.gz: 227c554bdd420091afdd134a753563d7cf4ec1443e8bfeea2dc22c214df098da2f9dceee4f6fe5101c2258859ddc95a3c80898e2f5d0d75d3e5baaf0dfaf7e33
+  metadata.gz: 9becd4e96f51c2cd5b4e2b2aff9a0a08c6807ef9d3d7556d1017ce74540b9fe918de7b2ba01fe460546f214d3994467d9e91d60d6e183a0fbff3c4c23e525ed7
+  data.tar.gz: 8265fdb5cb49b37d1f2adaa8490ad0cba31497a93addd2f1aefa6ac1742b130877e95ad96b247f49f9d47991e873ee604aac44119105b2071a38eb8a707f6e5c

data/lib/words_counted/counter.rb

@@ -1,35 +1,73 @@
 module WordsCounted
   class Counter
+    # @!attribute [Array] an array of words resulting for the string to act on.
     attr_reader :words
 
+    # This is the criteria for defining words.
+    #
+    # Words are alpha characters and can include hyphens and apostrophes.
     WORD_REGEX = /[^\p{Alpha}\-']+/
 
+    # Initializes an instance of Counter and splits a given string into an array of words.
+    #
+    #   Counter.new("Bad, bad, piggy!")
+    #   => #<WordsCounted::Counter:0x007fd49429bfb0 @words=["Bad", "bad", "piggy"]>
+    #
+    # @param string [String] the string to act on.
+    # @param filter [String] a string of words to filter from the string to act on.
+    #
     def initialize(string, filter = "")
       @words = string.split(WORD_REGEX).reject { |word| filter.split.include? word.downcase }
     end
 
+    # Returns the total word count.
+    #
     def word_count
       words.size
     end
 
+    # Returns a hash of words and their occurrences.
+    # Occurrences count is not case sensitive:
+    #
+    # `"Hello hello" #=> { "hello" => 2 }`
+    #
+    # @return [Hash] the resulting hash of words (keys) and their occurrences (values).
+    #
     def word_occurrences
       @occurrences ||= words.each_with_object(Hash.new(0)) { |word, result| result[word.downcase] += 1 }
     end
 
+    # Returns a hash of words and their lengths.
+    #
     def word_lengths
       @lengths ||= words.each_with_object({}) { |word, result| result[word] ||= word.length }
     end
 
+    # Returns a  two dimensional array of the most occuring word(s)
+    # and its number of occurrences.
+    #
+    # In the event of a tie, all tied words are returned.
+    #
     def most_occurring_words
       highest_ranking word_occurrences
     end
 
+    # Returns a  two dimensional array of the longest word(s) and
+    # its length.
+    #
+    # In the event of a tie, all tied words are returned.
+    #
     def longest_words
       highest_ranking word_lengths
     end
 
     private
 
+    # Takes a hashmap of the form {"foo" => 1, "bar" => 2} and returns an array
+    # containing the entries (as an array) with the highest number as a value.
+    #
+    # {http://codereview.stackexchange.com/a/47515/1563 See here}.
+    #
     def highest_ranking(entries)
       entries.group_by { |word, occurrence| occurrence }.sort.last.last
     end

data/lib/words_counted/version.rb

@@ -1,3 +1,3 @@
 module WordsCounted
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/words_counted.gemspec

@@ -1,6 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'words_counted/version'
 
 Gem::Specification.new do |spec|
@@ -10,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["husseini.mel@gmail.com"]
   spec.description   = %q{A Ruby word counter with helpful utility methods.}
   spec.summary       = %q{See README.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/abitdodgy/words_counted"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: words_counted
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mohamad El-Husseini
@@ -85,7 +85,7 @@ files:
 - spec/spec_helper.rb
 - spec/words_counted/counter_spec.rb
 - words_counted.gemspec
-homepage: ''
+homepage: https://github.com/abitdodgy/words_counted
 licenses:
 - MIT
 metadata: {}