middleman-spellcheck 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af6acef72c4a8c1198d0af0035eeb3300ea7b522
+  data.tar.gz: 5d13b60d36b5fbcc3201a53bb1b9e04a75036e7f
+SHA512:
+  metadata.gz: a4278e8b1e7c25e82bab5b6bb127ce40fff257fe22e896aed4aaca5c972ee9fa8f0a5f03a9e60dece55f23a8a61b1ac916195b87c89091b073067152a45c1713
+  data.tar.gz: 2aef6a45b02d6ee5b9c5159cfacaeccb0b9854fd500c52f4a9a491b9b2b3ca3e558c5ab91ef60d925c06bfdeb88ed55315797e74ca4f2d9dcf89128636c6e8e3

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/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem "middleman", :github => "middleman/middleman", :branch => "v3-stable"
+
+gemspec
+
+group :test do
+  gem "cucumber", "~> 1.3.1"
+  gem "fivemat"
+  gem "aruba",    "~> 0.5.1"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ivan Zarea
+
+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,45 @@
+# Middleman::Spellcheck
+
+Run a spell checker job after the app is built. Requires 'aspell'.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'middleman-spellcheck'
+
+And then execute:
+
+    $ bundle
+
+Add the following to middleman's `config.rb`:
+
+    activate :spellcheck
+
+## Usage
+
+You can spellcheck only some resources using a regex with the URL:
+
+```ruby
+activate :spellcheck, page: "documentation/*" # you can use regexes, too, e.g. /post_[1-9]/
+```
+
+You can limit which tags the spell checker will only run through:
+
+```ruby
+activate :spellcheck, tags: :p  # pass an array of tags if you have more!
+```
+
+If there are some words that you would like to be allowed
+
+```ruby
+activate :spellcheck, allow: ["Gooby", "pls"]
+```
+
+## 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,13 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  exempt_tags = ""
+  exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
+  t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
+end
+
+task :test => ["cucumber"]
+task :default => :test

data/features/allowed.feature

@@ -0,0 +1,6 @@
+Feature: Building an application with the spell checker allowed for some words
+
+  Scenario: The spelling errors in the allowed words is ignored
+    Given a fixture app "allow_app"
+    When I run `middleman build`
+    Then the exit status should be 0

data/features/only_tags.feature

@@ -0,0 +1,6 @@
+Feature: Building an application with the spell checker enabled for some tags
+
+  Scenario: The spelling errors in other tags are ignored
+    Given a fixture app "only_tags_app"
+    When I run `middleman build`
+    Then the exit status should be 0

data/features/page_params.feature

@@ -0,0 +1,6 @@
+Feature: Building an application with the spell checker enabled for some paths
+
+  Scenario: The spelling errors in the parameters that do not match the path are ignored
+    Given a fixture app "spelling_path_app"
+    When I run `middleman build`
+    Then the exit status should be 0

data/features/plain_app.feature

@@ -0,0 +1,6 @@
+Feature: Launching a plain application
+
+  Scenario: Shows a simple page
+    Given the Server is running at "plain_app"
+    When I go to "/"
+    Then I should see 'Hello, test'

data/features/spelling_check.feature

@@ -0,0 +1,11 @@
+Feature: Building an application with the spell checker enabled
+
+  Scenario: When the spelling is correct
+    Given a fixture app "correct_spelling_app"
+    When I run `middleman build`
+    Then the exit status should be 0
+
+  Scenario: When the spelling is incorrect
+    Given a fixture app "incorrect_spelling_app"
+    When I run `middleman build`
+    Then the exit status should be 1

data/features/support/env.rb

@@ -0,0 +1,6 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+ENV['TEST'] = 'true'
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-spellcheck')
+

data/fixtures/allow_app/config.rb

@@ -0,0 +1 @@
+activate :spellcheck, allow: ["dolan"]

data/fixtures/allow_app/source/index.html.erb

@@ -0,0 +1 @@
+Dolan walks into a park. dolan feels good.

data/fixtures/correct_spelling_app/config.rb

@@ -0,0 +1 @@
+activate :spellcheck

data/fixtures/correct_spelling_app/source/index.html.erb

@@ -0,0 +1 @@
+No spelling issues found here!

data/fixtures/incorrect_spelling_app/config.rb

@@ -0,0 +1 @@
+activate :spellcheck

data/fixtures/incorrect_spelling_app/source/index.html.erb

@@ -0,0 +1 @@
+Some speling isuses here!

data/fixtures/only_tags_app/config.rb

@@ -0,0 +1 @@
+activate :spellcheck, tags: :p

data/fixtures/only_tags_app/source/index.html.erb

@@ -0,0 +1,4 @@
+<p>This is written correctly</p>
+<div>Dis shud be ignord 4ever! im 13 what is div</div>
+<p>This is also written correctly</p>
+<p>This, too!</p>

data/fixtures/plain_app/source/index.html.erb

@@ -0,0 +1 @@
+Hello, <%= "TEST".downcase %>

data/fixtures/spelling_path_app/config.rb

@@ -0,0 +1 @@
+activate :spellcheck, page: "[^no_]check/*"

data/fixtures/spelling_path_app/source/check/index.html

@@ -0,0 +1 @@
+There are no spelling errors here

data/fixtures/spelling_path_app/source/no_check/index.html

@@ -0,0 +1 @@
+Theer are soome splelling erors her! Gooby pls.

data/lib/middleman-spellcheck.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+require "middleman-spellcheck/version"
+
+::Middleman::Extensions.register(:spellcheck) do
+    require "middleman-spellcheck/extension"
+      ::Middleman::Spellcheck::SpellcheckExtension
+end

data/lib/middleman-spellcheck/extension.rb

@@ -0,0 +1,84 @@
+require 'middleman-spellcheck/spellchecker'
+require 'nokogiri'
+
+module Middleman
+  module Spellcheck
+    class SpellcheckExtension < Extension
+      option :page, "/*", "Run only pages that match the regex through the spellchecker"
+      option :tags, [], "Run spellcheck only on some tags from the output"
+      option :allow, [], "Allow specific words to be misspelled"
+
+      def after_build(builder)
+        filtered = filter_resources(app, options.page)
+        total_misspelled = []
+
+        filtered.each do |resource|
+          builder.say_status :spellcheck, "Running spell checker for #{resource.url}", :blue
+          current_misspelled = run_check(select_content(resource))
+          current_misspelled.each do |misspell|
+            builder.say_status :misspell, error_message(misspell), :red
+          end
+          total_misspelled += current_misspelled
+        end
+
+        unless total_misspelled.empty?
+          raise Thor::Error, "Build failed. There are spelling errors."
+        end
+      end
+
+      def select_content(resource)
+        rendered_resource = resource.render(layout: false)
+        doc = Nokogiri::HTML(rendered_resource)
+
+        if options.tags.empty?
+          doc.text
+        else
+          select_tagged_content(doc, option_tags)
+        end
+      end
+
+      def option_tags
+        if options.tags.is_a? Array
+          options.tags
+        else
+          [options.tags]
+        end
+      end
+
+      def select_tagged_content(doc, tags)
+        tags.map { |tag| texts_for_tag(doc, tag.to_s) }.flatten.join(' ')
+      end
+
+      def texts_for_tag(doc, tag)
+        doc.css(tag).map(&:text)
+      end
+
+      def filter_resources(app, pattern)
+        app.sitemap.resources.select { |resource| resource.url.match(pattern) }
+      end
+
+      def run_check(text, dictionary="en")
+        results = Spellchecker.check(text, dictionary)
+        results = exclude_allowed(results)
+        results.reject { |entry| entry[:correct] }
+      end
+
+      def exclude_allowed(results)
+        results.reject { |entry| option_allowed.include? entry[:original].downcase }
+      end
+
+      def option_allowed
+        allowed = if options.allow.is_a? Array
+                    options.allow
+                  else
+                    [options.allow]
+                  end
+        allowed.map(&:downcase)
+      end
+
+      def error_message(misspell)
+        "The word '#{misspell[:original]}' is misspelled"
+      end
+    end
+  end
+end

data/lib/middleman-spellcheck/spellchecker.rb

@@ -0,0 +1,47 @@
+class Spellchecker
+  require 'net/https'
+  require 'uri'
+  require 'rexml/document'
+
+  ASPELL_WORD_DATA_REGEX = Regexp.new(/\&\s\w+\s\d+\s\d+(.*)$/)
+
+  @@aspell_path = "aspell"
+
+  def self.aspell_path=(path)
+    @@aspell_path = path
+  end
+
+  def self.aspell_path
+    @@aspell_path
+  end
+
+  def self.check(text, lang='en')
+    tmp = Tempfile.new('spellchecker-tmp')
+    tmp << text
+    tmp.flush
+    tmp.close
+    spell_check_response = `cat "#{tmp.path}" | #{@@aspell_path} -a -l #{lang}`
+    if spell_check_response == ''
+      raise 'Aspell command not found'
+    elsif text == ''
+      return []
+    else
+      response = text.split(' ').collect { |original| {:original => original} }
+      results = spell_check_response.split("\n").slice(1..-1)
+      result_index = 0
+      response.each_with_index do |word_hash, index|
+        if word_hash[:original] =~ /[a-zA-z\[\]\?]/
+          if results[result_index] =~ ASPELL_WORD_DATA_REGEX
+            response[index].merge!(:correct => false, :suggestions => results[result_index].split(':')[1].strip.split(',').map(&:strip))
+          else
+            response[index].merge!(:correct => true)
+          end
+          result_index += 1
+        else
+          response[index].merge!(:correct => true)
+        end
+      end
+      return response
+    end
+  end
+end

data/lib/middleman-spellcheck/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Spellcheck
+    VERSION = "0.2"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-spellcheck"

data/middleman-spellcheck.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-spellcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-spellcheck"
+  spec.version       = Middleman::Spellcheck::VERSION
+  spec.authors       = ["Ivan Zarea"]
+  spec.email         = ["zarea.ion@gmail.com"]
+  spec.description   = %q{Run spell checks as a build phase in middleman}
+  spec.summary       = %q{Run spell checks as a build phase in middleman}
+  spec.homepage      = "https://www.github.com/minivan/middleman-spellcheck"
+  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{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "middleman-core", ["~> 3.2"]
+  spec.add_runtime_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: middleman-spellcheck
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Ivan Zarea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Run spell checks as a build phase in middleman
+email:
+- zarea.ion@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/allowed.feature
+- features/only_tags.feature
+- features/page_params.feature
+- features/plain_app.feature
+- features/spelling_check.feature
+- features/support/env.rb
+- fixtures/allow_app/config.rb
+- fixtures/allow_app/source/index.html.erb
+- fixtures/correct_spelling_app/config.rb
+- fixtures/correct_spelling_app/source/index.html.erb
+- fixtures/incorrect_spelling_app/config.rb
+- fixtures/incorrect_spelling_app/source/index.html.erb
+- fixtures/only_tags_app/config.rb
+- fixtures/only_tags_app/source/index.html.erb
+- fixtures/plain_app/config.rb
+- fixtures/plain_app/source/index.html.erb
+- fixtures/spelling_path_app/config.rb
+- fixtures/spelling_path_app/source/check/index.html
+- fixtures/spelling_path_app/source/no_check/index.html
+- lib/middleman-spellcheck.rb
+- lib/middleman-spellcheck/extension.rb
+- lib/middleman-spellcheck/spellchecker.rb
+- lib/middleman-spellcheck/version.rb
+- lib/middleman_extension.rb
+- middleman-spellcheck.gemspec
+homepage: https://www.github.com/minivan/middleman-spellcheck
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Run spell checks as a build phase in middleman
+test_files: []