ivanvc-dictionary 0.0.0

data/extras/capitalized_english.txt

@@ -0,0 +1,7 @@
+Army
+Bid
+Carthorse
+Close
+Difference
+Mary
+Orchestra

data/extras/english.txt

@@ -0,0 +1,7 @@
+army
+bid
+carthorse
+close
+difference
+mary
+orchestra

data/lib/dictionary/anagram_extractor.rb

@@ -0,0 +1,98 @@
+module Dictionary
+  # The class AnagramExtactor, contains the implementation to get all the anagrams
+  # from a dictionary provided text file.
+  #
+  # @example Example Usage
+  #   extractor = AnagramExtractor.new('my_dictionary.txt')
+  #   extractor.extract!
+  #   extractor.export('anagrams.txt')
+  class AnagramExtractor
+    # Holds the dictionary file.
+    attr_reader :file
+    # Holds the anagrams extracted.
+    attr_reader :anagrams
+
+    # An AnagramExtactor instance should be initialized with the location of the file to scan. 
+    # 
+    # @raise [Dictionary::Error::FileNotFoundError] if the provided file is not found.
+    # @param [String, Pathname] file the location of the file.
+    def initialize(file=nil)
+      self.file = file if file
+    end
+
+    # Replaces the dictionary file. Also resets the dictionary and the extracted anagrams.
+    #
+    # @raise [Dictionary::Error::FileNotFoundError] if the provided file is not found.
+    # @param [String, Pathname] file the location of the file.
+    def file=(file)
+      reset_dictionaries
+      @file = get_full_location file
+      raise Error::FileNotFoundError unless File.exists?(@file)
+    end
+
+    # Extracts the anagrams from the provided file.
+    #
+    # @return [Array] the anagram list.
+    def extract!
+      reset_dictionaries
+      File.read(@file).each_line do |word|
+        word = word.strip
+        has_an_anagram = anagram_for? word
+        @anagrams += [word, has_an_anagram] if has_an_anagram
+        @dictionary << word
+      end
+      @anagrams
+    end
+
+    # Saves the anagram dictionary to a provided file.
+    #
+    # @param [String, Pathname] location the location of the file to write.
+    # @raise [Dictionary::Error::FileAlreadyExistsError] if the file already exists.
+    # @raise [Dictionary::Error::PathNotFoundError] if the export path does not exists.
+    # @return [String] the full path to the exported file. 
+    def export(location)
+      location    = get_full_location location
+      @anagrams ||= []
+
+      raise Dictionary::Error::FileAlreadyExistsError if File.exists? location
+      unless File.directory? File.dirname(location)
+        raise Dictionary::Error::PathNotFoundError
+      end
+      File.open(location, 'w') { |file| file.puts @anagrams.join("\n") }
+      location
+    end
+
+    private
+      # Will return if a word has an anagram in the currently extracted dictionary.
+      #
+      # @private
+      # @param [String] word the word to check
+      # @return [nil, String] nil if the dictionary is empty or, there are no anagrams for 
+      # this word. Else, the matching word.
+      def anagram_for?(word)
+        word_letters = word.downcase.scan(/\w/).sort
+        @dictionary.find do |test_word|
+          test_word_letters = test_word.downcase.scan(/\w/)
+          test_word_letters.size == word_letters.size &&
+            test_word_letters.sort == word_letters
+        end
+      end
+
+      # Resets the dictionary and the anagrams.
+      #
+      # @return [nil]
+      def reset_dictionaries
+        @dictionary = []
+        @anagrams   = []
+      end
+
+      # Standardizes the location of the passed file.
+      #
+      # @param [String, Pathname] file the file to scan.
+      # @return [String] the standardized location.
+      def get_full_location(file)
+        file = "#{Dir.pwd}/#{file}" unless Pathname.new(file).absolute?
+         File.expand_path(file)
+      end
+  end
+end

data/lib/dictionary/error.rb

@@ -0,0 +1,25 @@
+# Module for Exceptions from the Dictionary Module.
+module Dictionary::Error
+  # A FileNotFoundError may be raised by an AnagramExtactor class if the source file is not
+  # found.
+  #
+  # @see Dictionary::AnagramExtractor#initialize
+  # @see Dictionary::AnagramExtractor#file=
+  class FileNotFoundError < StandardError
+  end
+
+  # A PathNotFoundError may be raised by an AnagramExtactor class if the path to a file is not
+  # found.
+  #
+  # @see Dictionary::AnagramExtractor#export
+  # @see Dictionary::AnagramExtractor#file=  
+  class PathNotFoundError < StandardError
+  end
+
+  # A FileAlreadyExistsError may be raised by an AnagramExtactor class if the file already exists.
+  #
+  # @see Dictionary::AnagramExtractor#export
+  # @see Dictionary::AnagramExtractor#file=  
+  class FileAlreadyExistsError < StandardError
+  end
+end

data/lib/dictionary.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+
+# Module that contains the AnagramExtractor.
+module Dictionary
+  base_dir = File.expand_path(File.dirname(__FILE__) + '/dictionary') + '/'
+  autoload :AnagramExtractor, base_dir + 'anagram_extractor.rb'
+  autoload :Error, base_dir + 'error.rb'
+
+  # Extracts the anagrams from a file, and exports the results.
+  #
+  # @param [String, Pathname] file the location of the dictionary
+  # @param [String, Pathname] export_location the export location for the results.
+  # @return [String] The result of the extraction.
+  def self.extract_anagrams(file, export_location)
+    extractor = AnagramExtractor.new(file)
+    extractor.extract!
+    extractor.export(export_location)
+    "Exported anagram list to #{export_location}."
+  rescue Error::FileNotFoundError
+    "The source file seems to be missing."
+  rescue Error::PathNotFoundError
+    "The export path does not exist."
+  rescue Error::FileAlreadyExistsError
+    "The export file already exists."
+  end
+end

data/spec/anagram_extactor_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dictionary::AnagramExtractor do
+
+  before(:each) do
+    @extractor = Dictionary::AnagramExtractor.new
+  end
+
+  describe ".file=" do
+
+    it "should raise an error if file not found" do
+      lambda { @extractor.file = 'extras/notfound.txt' }.should\
+        raise_error(Dictionary::Error::FileNotFoundError)
+    end
+
+    it "should set it to the absolute path" do
+      @extractor.file = 'extras/english.txt'
+      Pathname.new(@extractor.file).should be_absolute
+    end
+
+    it "should clear the anagram list" do
+      @extractor.file = 'extras/english.txt'
+      @extractor.extract!        
+      
+      lambda { @extractor.file = 'extras/english.txt' }.should change(@extractor, :anagrams)
+      @extractor.anagrams.should be_empty
+    end
+
+  end
+
+  describe ".extract!" do
+
+    before(:each) do
+      @extractor.file = 'extras/english.txt'
+    end
+
+    it "should return an Array" do
+      @extractor.extract!.should be_an_instance_of(Array)
+    end
+
+    it "should return four matches" do
+      @extractor.extract!.size.should == 4
+    end
+
+    it "should return four matches even if words are capitalized" do
+      @extractor.file = 'extras/capitalized_english.txt'
+      @extractor.extract!.size.should == 4
+    end
+
+    it "should contain mary and army as anagrams" do
+      @extractor.extract!.should include('mary', 'army')
+    end
+
+  end
+
+  describe "export" do
+    before(:each) do
+      @location = "#{Dir.pwd}/example.txt"
+    end
+
+    after(:each) do
+      FileUtils.rm_rf @location
+    end
+
+    it "should raise an error if the output file already exists" do
+      lambda { @extractor.export 'extras/english.txt' }.should\
+        raise_error(Dictionary::Error::FileAlreadyExistsError)
+    end
+
+    it "should raise an error if the path of the file does not exist" do
+      lambda { @extractor.export 'chunky/bacon.txt' }.should\
+        raise_error(Dictionary::Error::PathNotFoundError)
+    end
+
+    it "should return the location of the output" do
+      @extractor.export('example.txt').should == @location
+    end
+
+    it "should write a file" do
+      @extractor.export 'example.txt'
+      File.exists?(@location).should be_true
+    end
+
+    it "should contain all the lines in @anagrams" do
+      @extractor.file = 'extras/english.txt'
+      @extractor.extract!
+      @extractor.export 'example.txt'
+
+      File.read(@location).split("\n").size.should == 4
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'dictionary'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: ivanvc-dictionary
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- "Iv\xC3\xA1n Vald\xC3\xA9s (@ivanvc)"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 -05:00
+default_executable: anagram_extractor
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Dictionary
+email: iv@nvald.es
+executables: 
+- anagram_extractor
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/anagram_extractor
+- extras/3k_english.txt
+- extras/capitalized_english.txt
+- extras/english.txt
+- lib/dictionary.rb
+- lib/dictionary/anagram_extractor.rb
+- lib/dictionary/error.rb
+- spec/anagram_extactor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ivanvc/dictionary
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Dictionary
+test_files: 
+- spec/anagram_extactor_spec.rb
+- spec/spec_helper.rb