words_counted 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0992a863d31573f13f2994d914701c22573edb2e
-  data.tar.gz: 83b5b5ca60aa6663321be5a24a791f829f9a0c23
+  metadata.gz: cba04e2004b13b0ee7b99e46cdf6549f6aebe2f6
+  data.tar.gz: 885d494f7f2b2af40f59ed08aaca1db7ec89a54b
 SHA512:
-  metadata.gz: a1363df462e354e03a825db08fb2eebb877fd656a817061ea1eb3777fc95710a8276fb6dd109f720e8826b2f64acbe1bd855190cab5961914a7f59aed534e7f5
-  data.tar.gz: 8f238c41e476c485721da16e207cdc739ccdefb44c8fdb26693976eece3fcafceefd0ffcd11af744383248d4266009d08754e92af93d40866bd267f7ef40d52d
+  metadata.gz: e2009cd4b401da2b43047699a073a3f541654384d831d73c0d436016eb88325e29c179a59961c6d1d8d48a865f34a2da78e014a28a5e0cf4ccf714cafa7a6bb5
+  data.tar.gz: f46e0031db714c0985ef4b2dee5d1f294c9ab0bdb629157110af0b26b76280bfe440207b4f6920156681cc91ded0246e3e66b6dcf26717208cc73ebbe4e86821

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Version 0.1.5
+
+1. Removed `to_f` from the dividend in `average_chars_per_word` and `word_densities`. The divisor is a float, and dividing by a float returns a float.
+2. Added `# -*- encoding : utf-8 -*-` to all files. See [pull request][1].
+3. Added this changelog.
+
+  [1]: https://github.com/abitdodgy/words_counted/pull/12

data/README.md

@@ -1,10 +1,10 @@
 # WordsCounted
 
-WordsCounted is a highly customisable Ruby string analyser. It includes many handy utility methods that go beyond word counting. You can use this gem to get word density, words and the number of times they occur, the highest occurring words, and few more things.
+WordsCounted is a highly customisable Ruby text analyser. Consult the features for more information.
 
-I use *word* loosely since you can pass the program any string you want: words, numbers, characters, etc...
-
-Pass your own regular expression to customise the criteria for splitting strings. This makes WordsCounted very flexible, whether you want to count words, numbers, or special characters.
+<a href="http://badge.fury.io/rb/words_counted">
+  <img src="https://badge.fury.io/rb/words_counted@2x.png" alt="Gem Version" height="18">
+</a>
 
 ### Demo
 
@@ -22,13 +22,14 @@ Visit [the gem's website][4] for a demo.
     * A hash map of words and their lengths
     * The longest word(s) and its length
     * The most occurring word(s) and its number of occurrences.
+    * Count invividual strings for occurrences.
 * A flexible way to exclude words (or anything) from the count. You can pass a **string**, a **regexp**, an **array**, or a **lambda**.
 * Customisable criteria. Pass your own regexp rules to split strings if you prefer. The default regexp has two features:
   * Filters special characters but respects hyphens and apostrophes.
   * Plays nicely with diacritics (UTF and unicode characters): "São Paulo" is treated as `["São", "Paulo"]` and not `["S", "", "o", "Paulo"]`.
-* Pass in a file path or a url instead of a string. WordsCounted opens and reads files.
+* Opens and reads files. Pass in a file path or a url instead of a string.
 
-See usage instructions for details on each feature.
+See usage instructions for more details.
 
 ## Installation
 
@@ -44,7 +45,7 @@ Or install it yourself as:
 
     $ gem install words_counted
 
-## Quick usage
+## Usage
 
 Pass in a string or a file path, and an optional filter and/or regexp.
 
@@ -71,12 +72,12 @@ counter = WordsCounted.count("Hello Beirut!")
 
 Accepts two options: `exclude` and `regexp`. See [Excluding words from the analyser][5] and [Passing in a custom regexp][6] respectively.
 
-#### from_file(path, options = {})
+#### `from_file(path, options = {})`
 
 Initializes an analyser object from a file path.
 
 ```ruby
-counter = WordsCounted.count("Hello Beirut!")
+counter = WordsCounted.count("hello_beirut.txt")
 ````
 
 Accepts the same options as `count()`.

data/lib/words_counted/counter.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module WordsCounted
   class Counter
     attr_reader :words, :word_occurrences, :word_lengths, :char_count
@@ -28,7 +29,7 @@ module WordsCounted
     end
 
     def average_chars_per_word(precision = 2)
-      (char_count.to_f / word_count.to_f).round(precision)
+      (char_count / word_count.to_f).round(precision)
     end
 
     def most_occurring_words
@@ -41,7 +42,7 @@ module WordsCounted
 
     def word_density(precision = 2)
       word_densities = word_occurrences.each_with_object({}) do |(word, occ), hash|
-        hash[word] = (occ.to_f / word_count.to_f * 100).round(precision)
+        hash[word] = (occ / word_count.to_f * 100).round(precision)
       end
       sort_by_descending_value word_densities
     end

data/lib/words_counted/version.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module WordsCounted
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/words_counted.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require "words_counted/version"
 require "words_counted/counter"
 

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: words_counted
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mohamad El-Husseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby word counter and string analyser with helpful utility methods.
@@ -73,9 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,12 +98,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []