words_counted 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9834aaae70272cc358a8bd7f846b56077c94c322
+  data.tar.gz: 80a6bd1a780307da11adc85a267ae8ad77b60be3
+SHA512:
+  metadata.gz: e0089b2b4ef682901c65c01641fb6643e7d85c3bf13b2b14dbb1a6d99b4ddaf1c5c74f8e40c7fd1a3ba3af8d4229cec229df98c826499d690b8a7db012279fd9
+  data.tar.gz: 227c554bdd420091afdd134a753563d7cf4ec1443e8bfeea2dc22c214df098da2f9dceee4f6fe5101c2258859ddc95a3c80898e2f5d0d75d3e5baaf0dfaf7e33

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in words_counted.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mohamad El-Husseini
+
+MIT License
+
+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,95 @@
+# Words Counted
+
+This Ruby gem is a word counter that includes some handy utility methods.
+
+### Features
+
+1. Count the number of words in a string.
+2. Get a hash of each word and the number of times it occurres.
+3. Get a hash of each word and its length.
+4. Get the most occurring word(s) and its number of occurrences.
+5. Get the longest word(s) and its length.
+6. Ability to filter words.
+7. Filters special characters but respects hyphens and apostrophes.
+
+See usage instructions for details on each feature.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'words_counted'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install words_counted
+
+## Usage
+
+Create an instance of `Counter` and pass in a string and an optional filter.
+
+```ruby
+counter = WordsCounted::Counter.new(
+	"We are all in the gutter, but some of us are looking at the stars."
+)
+```
+
+### `.word_count`
+
+Returns the word count of a given string. The word count includes only alpha characters. Hyphenated and words with apostrophes are considered a single word.
+
+```ruby
+counter.word_count #=> 15
+```
+### `.word_occurrences`
+
+Returns a hash of words and their number of occurrences. Uppercase and lowercase words are counted as the same word.
+
+```ruby
+counter.word_occurrences #=> { "we"=>1, "are"=>2, "all"=>1, "in"=>1, "the"=>2, "gutter"=>1, "but"=>1, "some"=>1, "of"=>1, "us"=>1, "looking"=>1, "at"=>1, "stars"=>1}
+```
+
+### `.most_occurring_words`
+
+Returns a two dimensional array of the highest occurring word and its number of occurrences. In case there is a tie all tied words are returned.
+
+```ruby
+counter.most_occurring_words #=> [["are", 2], ["the", 2]]
+```
+
+### `.word_lengths`
+
+Returns a hash of words and their lengths.
+
+```ruby
+counter.word_lengths #=> {"We"=>2, "are"=>3, "all"=>3, "in"=>2, "the"=>3, "gutter"=>6, "but"=>3, "some"=>4, "of"=>2, "us"=>2, "looking"=>7, "at"=>2, "stars"=>5}
+```
+
+### `.longest_word`
+
+Returns a two dimensional array of the longest word and its length. In case there is a tie all tied words are returned.
+
+## Filtering
+
+You can pass in a space-delimited word list to filter words that you don't want to count. Filter words should be lowercase. The filter will remove both uppercase and lowercase variants of the word.
+
+```ruby
+WordsCounted::Counter.new("That was magnificent, Trevor.", "that was")
+#=> <WordsCounted::Counter:0x007fd494312520 @words=["magnificent", "Trevor"]>
+```
+
+## About
+
+Originally I wrote this program for a code challenge. My initial implementation was decent, but it could have been better. Thanks to [Dave Yarwood](http://codereview.stackexchange.com/a/47515/1563) for helping me improve my code. Some of this code is based on his recommendations. You can find the original implementation as well as the code review on [Code Review](http://codereview.stackexchange.com/questions/46105/a-ruby-string-analyser).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec "irb -r words_counted -I ./lib"
+end

data/lib/words_counted/counter.rb

@@ -0,0 +1,37 @@
+module WordsCounted
+  class Counter
+    attr_reader :words
+
+    WORD_REGEX = /[^\p{Alpha}\-']+/
+
+    def initialize(string, filter = "")
+      @words = string.split(WORD_REGEX).reject { |word| filter.split.include? word.downcase }
+    end
+
+    def word_count
+      words.size
+    end
+
+    def word_occurrences
+      @occurrences ||= words.each_with_object(Hash.new(0)) { |word, result| result[word.downcase] += 1 }
+    end
+
+    def word_lengths
+      @lengths ||= words.each_with_object({}) { |word, result| result[word] ||= word.length }
+    end
+
+    def most_occurring_words
+      highest_ranking word_occurrences
+    end
+
+    def longest_words
+      highest_ranking word_lengths
+    end
+
+    private
+
+    def highest_ranking(entries)
+      entries.group_by { |word, occurrence| occurrence }.sort.last.last
+    end
+  end
+end

data/lib/words_counted/version.rb

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

data/lib/words_counted.rb

@@ -0,0 +1,10 @@
+require "words_counted/version"
+require "words_counted/counter"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module WordsCounted
+end

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+require 'words_counted'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# (such as loading up an entire rails app) will add to the boot time of your
+# test suite on EVERY test run, even for an individual file that may not need
+# all of that loaded.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # RSpec filters the backtrace by default so as not to be so noisy.
+    # This causes the full backtrace to be printed when running a single
+    # spec file (e.g. to troubleshoot a particular spec failure).
+    config.full_backtrace = true
+
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.formatter = 'doc' if config.formatters.none?
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/words_counted/counter_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+
+module WordsCounted
+  describe Counter do
+
+    describe ".words" do
+      let(:counter) { Counter.new("We are all in the gutter, but some of us are looking at the stars.") }
+
+      it "returns an array" do
+        expect(counter.words).to be_a(Array)
+      end
+
+      it "splits words" do
+        expect(counter.words).to eq(%w[We are all in the gutter but some of us are looking at the stars])
+      end
+
+      it "removes special characters" do
+        counter = Counter.new("Hello! # $ % 12345 * & % How do you do?")
+        expect(counter.words).to eq(%w[Hello How do you do])
+      end
+
+      it "counts hyphenated words as one" do
+        counter = Counter.new("I am twenty-two.")
+        expect(counter.words).to eq(%w[I am twenty-two])
+      end
+
+      it "does not split words on apostrophe" do
+        counter = Counter.new("Bust 'em! Them be Jim's bastards'.")
+        expect(counter.words).to eq(%w[Bust 'em Them be Jim's bastards'])
+      end
+
+      it "filters words" do
+        counter = Counter.new("That was magnificent, Trevor.", "magnificent")
+        expect(counter.words).to eq(%w[That was Trevor])
+      end
+    end
+
+    describe ".word_count" do
+      let(:counter) { Counter.new("In that case I'll take measures to secure you, woman!") }
+
+      it "returns the correct word count" do
+        expect(counter.word_count).to eq(10)
+      end
+    end
+
+    describe ".word_occurrences" do
+      let(:counter) { Counter.new("Bad, bad, piggy!") }
+
+      it "returns a hash" do
+        expect(counter.word_occurrences).to be_a(Hash)
+      end
+
+      it "treats capitalized words as the same word" do
+        expect(counter.word_occurrences).to eq({ "bad" => 2, "piggy" => 1 })
+      end
+    end
+
+    describe ".most_occurring_words" do
+      let(:counter) { Counter.new("One should always be in love. That is the reason one should never marry.") }
+
+      it "returns an array" do
+        expect(counter.most_occurring_words).to be_a(Array)
+      end
+
+      it "returns highest occuring words" do
+        expect(counter.most_occurring_words).to eq([["one", 2],["should", 2]])
+      end
+    end
+
+    describe '.word_lengths' do
+      let(:counter) { Counter.new("One two three.") }
+
+      it "returns a hash" do
+        expect(counter.word_lengths).to be_a(Hash)
+      end
+
+      it "returns a hash of word lengths" do
+        expect(counter.word_lengths).to eq({ "One" => 3, "two" => 3, "three" => 5 })
+      end
+    end
+
+    describe ".longest_words" do
+      let(:counter) { Counter.new("Those whom the gods love grow young.") }
+
+      it "returns an array" do
+        expect(counter.longest_words).to be_a(Array)
+      end
+
+      it "returns the longest words" do
+        expect(counter.longest_words).to eq([["Those", 5],["young", 5]])
+      end
+    end
+  end
+end

data/words_counted.gemspec

@@ -0,0 +1,25 @@
+# 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|
+  spec.name          = "words_counted"
+  spec.version       = WordsCounted::VERSION
+  spec.authors       = ["Mohamad El-Husseini"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: words_counted
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mohamad El-Husseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-30 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 with helpful utility methods.
+email:
+- husseini.mel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/words_counted.rb
+- lib/words_counted/counter.rb
+- lib/words_counted/version.rb
+- spec/spec_helper.rb
+- spec/words_counted/counter_spec.rb
+- words_counted.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: See README.
+test_files:
+- spec/spec_helper.rb
+- spec/words_counted/counter_spec.rb