yard-spellcheck 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "yard-spellcheck Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,7 @@
+### 0.1.0 / 2011-01-25
+
+* Initial release:
+  * Added {YARD::Spellcheck::Checker}.
+  * Added {YARD::Spellcheck::Printer}.
+  * Added {YARD::CLI::Spellcheck}.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hal Brodigan
+
+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,28 @@
+# yard-spellcheck
+
+* [Homepage](http://github.com/postmodern/yard-spellcheck)
+* [Issues](http://github.com/postmodern/yard-spellcheck/issues)
+* [Email](postmodern.mod3 at gmail.com)
+
+## Description
+
+Spellcheck your YARD documentation.
+
+## Synopsis
+
+    $ yard-spellcheck
+
+## Requirements
+
+* [yard](http://github.com/lsegal/yard) ~> 0.6.0
+* [ffi-hunspell](http://github.com/postmodern/ffi-hunspell) ~> 0.2.0
+
+## Install
+
+    $ gem install yard-spellcheck
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.3.0'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/bin/yard-spellcheck

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'yard'
+require 'yard/cli/spellcheck'
+
+YARD::CLI::Spellcheck.run(*ARGV)

data/gemspec.yml

@@ -0,0 +1,20 @@
+name: yard-spellcheck
+version: 0.1.0
+summary: Spellcheck your YARD documentat
+description:
+  Adds the 'spellcheck' command to YARD, which will spellcheck every
+  docstring within your documentation.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/yard-spellcheck
+has_yard: true
+
+dependencies:
+  yard: ~> 0.6.0
+  ffi-hunspell: ~> 0.2.0
+
+development_dependencies:
+  ore-tasks: ~> 0.3.0
+  rspec: ~> 2.4.0

data/lib/yard/cli/spellcheck.rb

@@ -0,0 +1,99 @@
+require 'yard/spellcheck/checker'
+require 'yard/spellcheck/printer'
+
+module YARD
+  module CLI
+    #
+    # The `yard-spellcheck` command.
+    #
+    class Spellcheck < Command
+
+      # The spellchecker.
+      attr_reader :checker
+
+      #
+      # Initializes the spellcheck command.
+      #
+      def initialize
+        @checker = YARD::Spellcheck::Checker.new
+        @names = []
+        @stats = false
+      end
+
+      #
+      # The command description.
+      #
+      # @return [String]
+      #   Description.
+      #
+      def description
+        'Spellchecks YARD documentation'
+      end
+
+      #
+      # Runs the spellcheck command.
+      #
+      # @param [Array<String>] args
+      #   The arguments for the command.
+      #
+      def run(*args)
+        optparse(*args)
+
+        @checker.check!(@names) do |element,typos|
+          print_typos element, typos
+        end
+
+        if @stats
+          puts "Statistics"
+          print_stats @checker
+        end
+      end
+
+      protected
+
+      include YARD::Spellcheck::Printer
+
+      #
+      # Parses the command options.
+      #
+      # @param [Array<String>] args
+      #   The arguments for the command.
+      #
+      def optparse(*args)
+        opts = OptionParser.new
+        opts.banner = "Usage: yard spellcheck [options]"
+        opts.separator ""
+        opts.separator description
+        opts.separator ""
+
+        opts.on('-D','--dict-dir','Dictionary directory') do |dir|
+          FFI::Hunspell.directories << File.expand_path(dir)
+        end
+
+        opts.on('-c','--check [CLASS | MODULE]','Classes/Modules to spellcheck') do |name|
+          @names << name
+        end
+
+        opts.on('-L','--lang LANG','Language to spellcheck for') do |lang|
+          @checker.lang = lang
+        end
+
+        opts.on('-I','--ignore WORD','Words to ignore') do |word|
+          @checker.ignored << word
+        end
+
+        opts.on('-a','--add WORD [...]','Adds a word') do |word|
+          @checker.added << word
+        end
+
+        opts.on('-S','--statistics','Print statistics') do
+          @stats = true
+        end
+
+        common_options(opts)
+        parse_options(opts,args)
+      end
+
+    end
+  end
+end

data/lib/yard/spellcheck/checker.rb

@@ -0,0 +1,184 @@
+require 'ffi/hunspell'
+require 'set'
+require 'yard'
+
+module YARD
+  module Spellcheck
+    #
+    # Handles loading and spellchecking YARD Documentation.
+    #
+    class Checker
+
+      # YARD tags to not spellcheck.
+      SKIP_TAGS = Set['example', 'since', 'see', 'api']
+
+      # The Regexp to use for scanning in words.
+      WORD_REGEXP = /[^\W_][[^\W_]'-]*[^\W_]/
+
+      # The language to spellcheck against.
+      attr_accessor :lang
+
+      # The words to ignore.
+      attr_reader :ignore
+
+      # The words to add to the dictionary.
+      attr_reader :added
+
+      # The known words from the documentation.
+      attr_reader :known
+
+      # The misspelled words.
+      attr_reader :misspelled
+
+      #
+      # Initializes the spellchecker.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [String, Symbol] :lang (FFI::Hunspell.lang)
+      #   The language to spellcheck against.
+      #
+      # @option options [Array, Set] :ignore
+      #   The words to ignore.
+      #
+      # @option options [Array, Set] :add
+      #   The words to add to the dictionary.
+      #
+      def initialize(options={})
+        @lang = options.fetch(:lang,FFI::Hunspell.lang)
+        @ignore = Set[]
+        @added = Set[]
+
+        if options[:ignore]
+          @ignored += options[:add]
+        end
+
+        if options[:add]
+          @added += options[:add]
+        end
+
+        @known = Set[]
+        @misspelled = Hash.new { |hash,key| hash[key] = 0 }
+      end
+
+      #
+      # Spellchecks the YARD Documentation.
+      #
+      # @param [Array<String>] names
+      #   The Classes/Modules to spellcheck.
+      #
+      # @yield [element, typos]
+      #   The given block will be passed each element and any typos found.
+      #
+      # @yieldparam [YARD::Docstring, YARD::Tag] element
+      #   An element from the YARD Documentation.
+      #
+      # @yieldparam [Set<String>] typos
+      #   Any typos found within the element.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator will be returned.
+      #
+      def check!(names=[],&block)
+        return enum_for(:check!) unless block
+
+        # load the YARD cache
+        YARD::Registry.load!
+
+        # clear any statistics from last run
+        @known.clear
+        @misspelled.clear
+
+        # load known Class and Module names
+        YARD::Registry.all(:class, :module).each do |obj|
+          obj.path.split('::').each { |name| @known << name }
+        end
+
+        FFI::Hunspell.dict(@lang) do |dict|
+          # add user specified words
+          @added.each { |word| dict.add(word) }
+
+          unless names.empty?
+            names.each do |name|
+              if (obj = YARD::Registry.at(name))
+                spellcheck_object(obj,dict,&block)
+              end
+            end
+          else
+            YARD::Registry.each do |obj| 
+              spellcheck_object(obj,dict,&block)
+            end
+          end
+        end
+      end
+
+      protected
+
+      #
+      # Spellchecks a YARD Documentation object.
+      #
+      # @param [YARD::CodeObject::Base] obj
+      #   The YARD Documentation object.
+      #
+      # @param [FFI::Hunspell::Dictionary] dict
+      #   The dictionary to spellcheck against.
+      #
+      # @yield [element, typos]
+      #   The given block will be passed each element and any typos found.
+      #
+      # @yieldparam [YARD::Docstring, YARD::Tag] element
+      #   An element from the YARD Documentation.
+      #
+      # @yieldparam [Set<String>] typos
+      #   Any typos found within the element.
+      #
+      def spellcheck_object(obj,dict)
+        docstring = obj.docstring
+
+        unless (typos = spellcheck(docstring,dict)).empty?
+          yield docstring, typos
+        end
+
+        docstring.tags.each do |tag|
+          next if SKIP_TAGS.include?(tag.tag_name)
+
+          if tag.text
+            unless (typos = spellcheck(tag.text,dict)).empty?
+              yield tag, typos
+            end
+          end
+        end
+      end
+
+      #
+      # Spellchecks a piece of text.
+      #
+      # @param [String] text
+      #   The text to spellcheck.
+      #
+      # @param [FFI::Hunspell::Dictionary] dict
+      #   The dictionary to use.
+      #
+      # @return [Set<String>]
+      #   The misspelled words from the text.
+      #
+      def spellcheck(text,dict)
+        typos = Set[]
+
+        text.scan(WORD_REGEXP).each do |word|
+          next if (@known.include?(word) || @ignore.include?(word))
+
+          if (@misspelled.has_key?(word) || !dict.valid?(word))
+            @misspelled[word] += 1
+
+            typos << word
+          end
+        end
+
+        return typos
+      end
+
+    end
+  end
+end

data/lib/yard/spellcheck/printer.rb

@@ -0,0 +1,91 @@
+require 'yard/spellcheck/checker'
+
+module YARD
+  module Spellcheck
+    #
+    # Provides methods for printing the typos found in YARD Documentation.
+    #
+    module Printer
+      # Highlights text
+      HIGHLIGHT = "\e[31m\e[4m"
+
+      # Unhighlights text
+      UNHIGHLIGHT = "\e[0m"
+
+      #
+      # Prints typos in a YARD Documentation element.
+      #
+      # @param [YARD::Docstring, YARD::Tags::Tag] element
+      #   The element that the typos occurred in.
+      #
+      # @param [Set<String>] typos
+      #   The typos that were found in the element.
+      #
+      def print_typos(element,typos)
+        case element
+        when YARD::Docstring
+          line = if element.line_range
+                   element.line_range.first
+                 else
+                   1
+                 end
+
+          puts "Typos in #{element.object} (#{element.object.file}:#{line})"
+
+          print_text line, element, typos
+        when YARD::Tags::Tag
+          puts "Typos in @#{element.tag_name} #{element.name} (#{element.object.file}:#{element.object.line})"
+
+          print_text element.object.line, element.text, typos
+        end
+      end
+
+      #
+      # Prints text containing typos.
+      #
+      # @param [Integer] line_number
+      #   The line number that the text starts on.
+      #
+      # @param [String] text
+      #   The text to print.
+      #
+      # @param [Set<String>] typos
+      #   The typos that occurred within the text.
+      #
+      def print_text(line_number,text,typos)
+        # highlight the typos
+        highlighted = text.gsub(Checker::WORD_REGEXP) do |word|
+          if typos.include?(word)
+            "#{HIGHLIGHT}#{word}#{UNHIGHLIGHT}"
+          else
+            word
+          end
+        end
+
+        puts ''
+
+        # print the lines
+        highlighted.each_line do |line|
+          puts "  #{line_number} #{line}"
+          line_number += 1
+        end
+
+        puts ''
+      end
+
+      #
+      # Prints statistics gathered by the spellchecker.
+      #
+      # @param [Checker] checker
+      #   The spellchecker.
+      #
+      def print_stats(checker)
+        stats = checker.misspelled.sort_by { |word,count| -count }
+
+        stats.each_with_index do |(word,count),index|
+          puts "  #{index + 1}. #{word} (#{count})"
+        end
+      end
+    end
+  end
+end

data/lib/yard-spellcheck.rb

@@ -0,0 +1,4 @@
+require 'yard'
+require 'yard/cli/spellcheck'
+
+YARD::CLI::CommandParser.commands[:spellcheck] = YARD::CLI::Spellcheck

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+gem 'rspec', '~> 2.4.0'
+require 'rspec'

data/yard-spellcheck.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The 'yard-spellcheck.gemspec' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: yard-spellcheck
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-25 00:00:00 -08:00
+default_executable: yard-spellcheck
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ffi-hunspell
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+description: Adds the 'spellcheck' command to YARD, which will spellcheck every docstring within your documentation.
+email: postmodern.mod3@gmail.com
+executables: 
+- yard-spellcheck
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/yard-spellcheck
+- gemspec.yml
+- lib/yard-spellcheck.rb
+- lib/yard/cli/spellcheck.rb
+- lib/yard/spellcheck/checker.rb
+- lib/yard/spellcheck/printer.rb
+- spec/spec_helper.rb
+- yard-spellcheck.gemspec
+has_rdoc: yard
+homepage: http://github.com/postmodern/yard-spellcheck
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: yard-spellcheck
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Spellcheck your YARD documentat
+test_files: []
+