middleman-language_tool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65347858f176ae1672776a9266ff2a6d394566ad
+  data.tar.gz: 3009bb0648d39777f35729f3abacb2b241438ce4
+SHA512:
+  metadata.gz: 304f434de828483ef626a104308b93bf1fce56acc483d7992a4c7c787ff3f88df8a85f6d0b59a77f86073a55a0e961633db2e24e44e9912b0a25984a96694f9d
+  data.tar.gz: d6f69026a5c4de35b9ca953ef0e7ef06aeb356dd3a8602e3f705cc4fe2d461d707be55fa04d38179dd751056ff1a17afc7034a7e07e4da122be615f07e362fdb

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 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem "middleman"
+
+gemspec
+
+group :test do
+  gem "cucumber", "~> 1.3.1"
+  gem "fivemat"
+  gem "aruba",    "~> 0.5.1"
+  gem "rspec"
+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,49 @@
+# Middleman-LanguageTooler
+
+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
+
+## Thanks
+
+Special thanks to [Readbeard-Tech](https://rubygems.org/profiles/redbeard-tech) for the [spellchecker](https://rubygems.org/gems/spellchecker) gem, which this code is based upon.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks

data/lib/middleman-language_tool.rb

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

data/lib/middleman-language_tool/extension.rb

@@ -0,0 +1,96 @@
+require 'nokogiri'
+require 'language_tool'
+
+module Middleman
+  module LanguageTool
+    class LanguageToolExtension < Extension
+      REJECTED_EXTS = %w(.css .js .coffee)
+      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)
+        language_tool = ::LanguageTool::Process.new
+        language_tool.start!
+        spellchecker = ::LanguageTool::ErrorParser.new(language_tool)
+
+        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(spellchecker, 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) }
+                             .reject { |resource| REJECTED_EXTS.include? resource.ext }
+      end
+
+      def run_check(spellchecker, text)
+        errors = spellchecker.find_errors(text)
+        errors.reject { |e| e.ruleId == "WHITESPACE_RULE" }
+        #results = exclude_allowed(results)
+        #results.reject { |entry| entry[:correct] }
+      end
+
+      def exclude_allowed(results)
+        results.reject { |entry| option_allowed.include? entry[:word].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)
+        "Category: #{misspell.category}\n" \
+        "Message: #{misspell.msg}\n" \
+        "Context: #{misspell.context}\n" \
+        "Replacements: #{misspell.replacements.split('#').join(' ')}\n" \
+
+        #"The word '#{misspell[:word]}' is misspelled"
+      end
+    end
+  end
+end

data/lib/middleman-language_tool/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module LanguageTool
+    VERSION = "0.0.1"
+  end
+end

data/lib/middleman-spellcheck.rb

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

data/lib/middleman_extension.rb

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

data/middleman-language_tool.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-language_tool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-language_tool"
+  spec.version       = Middleman::LanguageTool::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/skade/middleman-language_tool"
+  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_runtime_dependency "language_tool"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: middleman-language_tool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Zarea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-02 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: language_tool
+  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"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middleman-language_tool.rb
+- lib/middleman-language_tool/extension.rb
+- lib/middleman-language_tool/version.rb
+- lib/middleman-spellcheck.rb
+- lib/middleman_extension.rb
+- middleman-language_tool.gemspec
+homepage: https://www.github.com/skade/middleman-language_tool
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Run spell checks as a build phase in middleman
+test_files: []