words_counted 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c56052462cafa83864d9f6ae8fcc9edcdd67356
-  data.tar.gz: 562629bb6b6f61d45a2e40ae0fab5b07e749576e
+  metadata.gz: 9596a5852bcc4c417a62f4ec4aa2153eed7d4297
+  data.tar.gz: fad6c9456601aff8c709b1a385d9638e68140ac5
 SHA512:
-  metadata.gz: 96a6ee9b686893bef4552aedd4dd05f696bf5735cb57c9de65b08f7a6ed6c0a4cbceddd27f8309d0f0522753ff0c556fa5b8ec7bf949a1c3c7c07d9ad1b11337
-  data.tar.gz: 05251ab8e6efa3b29ebd88d7c5ddf82c20bfa3c07321a7a66a9f261c4b1162cdae600cd991b4b243c94d660fc2bfd45d779098f8dcda9f0165474965d8d5b9b8
+  metadata.gz: f0891409f8b63f89527fd68e8fed3ef2f917b9b342a0aabd6a00479627bea4ef2e9552810a25a4fd103529bc8cda846b9b50624c91437c0cf6a94b7e4e316c6c
+  data.tar.gz: 36c3c925b20388d86a5ef582e9ad09ca74b1f9fda8a9a66113ed5783d5123b2d99db342450a54e76278b41990c1301c6e31750ee7c5072aacf21e544147cd82c

data/lib/words_counted.rb

@@ -1,6 +1,8 @@
 # -*- encoding : utf-8 -*-
 require "refinements/hash_refinements"
 
+require "words_counted/deprecated"
+
 require "words_counted/tokeniser"
 require "words_counted/counter"
 require "words_counted/version"
@@ -11,11 +13,27 @@ rescue LoadError
 end
 
 module WordsCounted
-  def self.count(string, options = {})
-    tokens = Tokeniser.new(string).tokenise(options)
+  # Takes a string, tokenises it, and returns an instance of Counter
+  # with the resulting tokens.
+  #
+  # @see Tokeniser.tokenise
+  # @see Counter.initialize
+  #
+  # @param [String] input   The input to be tokenised.
+  # @param [Hash] options   The options to pass onto `Counter`.
+  def self.count(input, options = {})
+    tokens = Tokeniser.new(input).tokenise(options)
     Counter.new(tokens)
   end
 
+  # Takes a file path, reads the file and tokenises its contents,
+  # and returns an instance of Counter with the resulting tokens.
+  #
+  # @see Tokeniser.tokenise
+  # @see Counter.initialize
+  #
+  # @param [String] path    The file to be read and tokenised.
+  # @param [Hash] options   The options to pass onto `Counter`.
   def self.from_file(path, options = {})
     tokens = File.open(path) do |file|
       Tokeniser.new(file.read).tokenise(options)

data/lib/words_counted/counter.rb

@@ -1,7 +1,4 @@
 # -*- encoding : utf-8 -*-
-
-require "words_counted/deprecated"
-
 module WordsCounted
   using Refinements::HashRefinements
 

data/lib/words_counted/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module WordsCounted
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: words_counted
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mohamad El-Husseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-24 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler