merimee 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

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

data/README.md

@@ -0,0 +1,85 @@
+# merimee
+
+> Pour parler sans ambiguïté, ce dîner à Sainte-Adresse, près du Havre, malgré les effluves embaumés de la mer, malgré les vins de très bons crus, les cuisseaux de veau et les cuissots de chevreuil prodigués par l’amphitryon, fut un vrai guêpier.
+
+_merimee_ adds some `rspec` macros (`Test::Case` to come ... maybe) to add automatic spell checking to your tests.
+
+## Install
+
+```
+gem 'merimee'
+```
+
+## Configuration
+
+The config object has the following methods/arguments :
+```
+Merime::Checker.new do |config|
+  config.dict_add 'OHAI' # Ignore OHAI spelling errors. This is case sensitive for now, feel free to tell me if you feel it shouldn't be the case.
+  config.dict_add %w{Trealiu Chtulu} # Ignore other words, method takes any enumerable too !
+  config.dict_add_file 'blah.txt' # Ignore all words from blah.txt, one per line
+  config.language = 'en' # English by default, but AfterTheDeadline also supports French(fr), Spanish(es), German(de), Portuguese(pt)
+  # AtD says that you should provide a key, unique per use. You don't need to register/get it, but
+  # you can't have more than one request on their servers at the same time with the same key.
+  # Since merimee is intended for test mode, it should be fine.
+  config.api_key = 'blah' # See AtD documentation here : it's not needed, the gem is smart enough, especially in test mode
+  
+  config.ignore_types << 'spelling' # You can ignore some types of errors.
+end
+```
+
+## Usage
+
+### Standalone use
+
+Well, you need to initalize a `Merimee::Checker` with a `Merimee::Config`
+
+```ruby
+checker = Merimee::Checker.new do |config|
+  # Configure if needed
+end
+# checker = Merimee::Checker.new would be equivalent here
+# checker = Merimee::Checker.new(Merime::Config.new) too
+
+checker.check('This text has one BIGE error')
+=> [BIGE spelling]
+```
+
+Error objects have some interesting fields (`type`, `suggestions`, `url`, `description`), inspect them to know more.
+
+### Rspec/rails
+Just drop a `require 'merimee'` in your `spec_helper.rb`.
+It gives you the following in your views :
+
+```ruby
+describe 'splash/index' do
+  it_should_have_correct_spelling
+end
+
+# Which is equivalent to
+describe 'splash/logout' do
+  it "should have a correct spelling" do
+    render
+    rendered.should have_a_correct_spelling
+  end
+end
+```
+
+#### Configuration with RSpec
+You can still modify your config within RSpec :
+
+```ruby In your spec_helper.rb
+require 'merimee'
+
+RSpec.configure do |config|
+  config.merimee_config.dict_add 'ignoreThisWord'
+end
+```
+
+## Known issues
+
+See http://github.com/coutud/merimee/issues
+
+## Thanks etc.
+
+This gem was based on some code from https://github.com/msepcot/after_the_deadline

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+    sh "irb -rubygems -I lib -r merimee.rb"
+end

data/lib/merimee.rb

@@ -0,0 +1,20 @@
+require "merimee/version"
+
+require "merimee/checker"
+require "merimee/config"
+require "merimee/after_the_deadline"
+
+require 'merimee/railties/merimee_railtie.rb' if defined?(Rails)
+
+if defined?(RSpec) && defined?(RSpec::Matchers)
+  require 'merimee/rspec/view_checker_helper.rb'
+  RSpec.configuration.add_setting :merimee_config
+
+  RSpec.configure do |config|
+    config.merimee_config = Merimee::Config.new
+    config.extend Merimee::Rspec::ViewCheckerHelper, :type => :view
+  end
+end
+
+module Merimee
+end

data/lib/merimee/after_the_deadline.rb

@@ -0,0 +1,98 @@
+require 'crack'
+require 'net/http'
+require 'uri'
+
+class AfterTheDeadline
+  BASE_URIS = {
+    'en' => 'http://service.afterthedeadline.com',
+    'fr' => 'http://fr.service.afterthedeadline.com',
+    'de' => 'http://de.service.afterthedeadline.com',
+    'pt' => 'http://pt.service.afterthedeadline.com',
+    'es' => 'http://es.service.afterthedeadline.com'
+    }
+  BASE_URI = 'http://service.afterthedeadline.com'
+
+  class << self
+    attr_accessor :key, :language
+    # Invoke the checkDocument service with provided text.
+    # 
+    # Returns list of AfterTheDeadline::Error objects.
+    def check(data)
+      results = Crack::XML.parse(perform('/checkDocument', :data => data))['results']
+      return [] if results.nil? # we have no errors in our data
+
+      raise "Server returned an error: #{results['message']}" if results['message']
+      errors = if results['error'].kind_of?(Array)
+                 results['error'].map { |e| AfterTheDeadline::Error.new(e) }
+               else
+                 [AfterTheDeadline::Error.new(results['error'])]
+               end
+
+      return errors
+    end
+    alias :check_document :check
+
+    # Invoke the stats service with provided text.
+    # 
+    # Returns AfterTheDeadline::Metrics object.
+    def metrics(data)
+      results = Crack::XML.parse(perform('/stats', :data => data))['scores']
+      return if results.nil? # we have no stats about our data
+      AfterTheDeadline::Metrics.new results['metric']
+    end
+    alias :stats :metrics
+
+    def perform(action, params)
+      uri = URI.parse(BASE_URIS[@language] + action)
+      response = Net::HTTP.post_form uri, params.update(:key => @key)
+      raise "Unexpected response code from AtD service: #{response.code} #{response.message}" unless response.is_a? Net::HTTPSuccess
+      response.body
+    end
+  end
+
+  private_class_method :perform
+end
+
+class AfterTheDeadline::Error
+  attr_reader :string, :description, :precontext, :type, :suggestions, :url
+
+  def initialize(hash)
+    raise "#{self.class} must be initialized with a Hash" unless hash.kind_of?(Hash)
+    [:string, :description, :precontext, :type, :url].each do |attribute|
+      self.send("#{attribute}=", hash[attribute.to_s])
+    end
+    self.suggestions = hash['suggestions'].nil? ? [] : [*hash['suggestions']['option']]
+  end
+
+  def info(theme = nil)
+    return unless self.url
+    uri = URI.parse self.url
+    uri.query = (uri.query || '') + "&theme=#{theme}"
+    Net::HTTP.get(uri).strip
+  end
+
+  def to_s
+    "#{self.string} (#{self.description})"
+  end
+
+  private
+  attr_writer :string, :description, :precontext, :type, :suggestions, :url
+end
+
+class AfterTheDeadline::Metrics
+  attr_reader :spell, :grammer, :stats, :style
+
+  def initialize(array)
+    unless array.kind_of?(Array) && array.all? {|i| i.kind_of?(Hash) }
+      raise "#{self.class} must be initialized with an Array of Hashes"
+    end
+
+    self.spell, self.grammer, self.stats, self.style = {}, {}, {}, {}
+    array.each do |metric|
+      self.send(metric['type'])[metric['key']] = metric['value']
+    end
+  end
+
+  private
+  attr_writer :spell, :grammer, :stats, :style
+end

data/lib/merimee/checker.rb

@@ -0,0 +1,30 @@
+# Main checker class
+# Heavily inspired by the old AfterTheDeadline github repo
+module Merimee
+  class Checker
+    attr_reader :config
+    def initialize(config = nil)
+      @config = config || Config.new
+      yield @config if block_given?
+    end
+
+    def check(text, options = {})
+      AfterTheDeadline.language = options[:language] || @config.language
+      AfterTheDeadline.key = @config.api_key
+      errors = AfterTheDeadline.check(text)
+      
+      # Remove any error types we don't care about
+      errors.reject! { |e| @config.ignore_types.include?(e.description) }
+
+      # Remove spelling errors from our custom dictionary
+      # Also remove stuff that is obviously not a word (AtD seems to have issues sometime)
+      errors.reject! do |e|
+        e.type == 'spelling' &&
+          @config.dictionary.include?(e.string)
+      end
+      errors
+    end
+
+  end
+
+end

data/lib/merimee/config.rb

@@ -0,0 +1,51 @@
+require 'digest/sha1'
+
+module Merimee
+  DEFAULT_IGNORE_TYPES = ['Bias Language', 'Cliches', 'Complex Expression', 'Diacritical Marks', 'Double Negatives', 'Hidden Verbs', 'Jargon Language', 'Passive voice', 'Phrases to Avoid', 'Redundant Expression']
+  DEFAULT_LANGUAGE = 'en'
+
+  class Config
+    attr_reader :dictionary
+    attr_accessor :ignore_types
+    
+    # This is required by the service for caching purposes,
+    # but no registration is needed (api_key should just be unique for
+    # your app, only one request can happen per key at any moment).
+    # There shouldn't be any need for this, but still
+    attr_accessor :api_key
+    # The language to use for this check
+    # This is used to select the proper AtD server, unless overriden with the
+    # :language option
+    attr_accessor :language
+
+    def initialize
+      @dictionary = []
+      @ignore_types = Merimee::DEFAULT_IGNORE_TYPES
+      @api_key = Config.generate_api_key
+      @language = Merimee::DEFAULT_LANGUAGE
+    end
+
+    def dict_add(word)
+      if word.kind_of?(String)
+        @dictionary << word
+      elsif word.kind_of?(Enumerable)
+        @dictionary.concat word
+      end
+    end
+
+    def dict_add_file(file)
+      File.open(file) {|f| dict_add(f.readlines.map(&:strip)) }
+    end
+
+    private
+    # We just use the path to this file, and the current hostname
+    # If you
+    # This is probably not totally unique
+    # We use the mac address and this file path, should be unique enough
+    def self.generate_api_key
+      data = [File.expand_path(__FILE__)]
+      data << Mac.addr if defined?(Mac)
+      Digest::SHA1.hexdigest(data.join)
+    end
+  end
+end

data/lib/merimee/railties/merimee_railtie.rb

@@ -0,0 +1,7 @@
+module Merimee
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      require 'path/to/railtie.tasks'
+    end
+  end
+end

data/lib/merimee/rspec/view_checker_helper.rb

@@ -0,0 +1,36 @@
+module Merimee
+  module Rspec
+    module ViewCheckerHelper
+      RSpec::Matchers.define :have_a_correct_spelling do
+        match do |rendered|
+          checker = Merimee::Checker.new(::RSpec.configuration.merimee_config)
+
+          if rendered
+            @errors = checker.check(rendered)
+            @errors.empty?
+          else
+            true
+          end
+        end
+        failure_message_for_should do |view|
+          errs = []
+          @errors.each do |err|
+            message = "[#{err.type}] #{err.string}"
+            if err.suggestions
+              message << " (suggested: #{err.suggestions.join(', ')})"
+            end
+            errs << message
+          end
+          errs.join("\n")
+        end
+      end
+
+      def it_should_have_a_correct_spelling
+        it "should have a correct spelling" do
+          render
+          rendered.should have_a_correct_spelling
+        end
+      end
+    end
+  end
+end

data/lib/merimee/version.rb

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

data/merimee.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "merimee/version"
+
+Gem::Specification.new do |s|
+  s.name        = "merimee"
+  s.version     = Merimee::VERSION
+  s.authors     = ["coutud"]
+  s.email       = ["wam@atwam.com"]
+  s.homepage    = ""
+  s.summary     = %q{Add spell checking to your views tests/specs}
+  s.description = %q{Automatically submit your rendered views to AfterTheDeadline free spell check service, and make sure you don't have any errors in your views !}
+
+  s.rubyforge_project = "merimee"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency 'crack'
+
+  s.add_development_dependency 'minitest'
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/test/checker_test.rb

@@ -0,0 +1,26 @@
+require 'minitest/autorun'
+require 'merimee'
+
+require 'digest/sha1'
+
+class CheckerTest < MiniTest::Unit::TestCase
+  ATD_SLEEP = 0.7
+  def setup
+    @checker = Merimee::Checker.new
+  end
+
+  def test_check_perfect_text
+    sleep ATD_SLEEP # Make sure we sleep a bit, AtD returns 503 if requests are too close
+    errors = @checker.check("Perfect text")
+    assert_empty errors
+  end
+
+  def test_text_with_errors
+    erroneous_text = "Wrong text garanteed with errors"
+    sleep ATD_SLEEP # Make sure we sleep a bit, AtD returns 503 if requests are too close
+    errors = @checker.check(erroneous_text)
+
+    refute_empty errors
+    assert_equal "garanteed", errors.first.string
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'merimee'
+
+class ConfigTest < MiniTest::Unit::TestCase
+  def setup
+    @config = Merimee::Config.new
+  end
+
+  def test_ignore_type_not_empty_by_default
+    refute_empty @config.ignore_types
+  end
+
+  def test_add_dict_with_word
+    @config.dict_add "OHAI"
+    assert_includes @config.dictionary, "OHAI"
+  end
+
+  def test_add_dict_with_array
+    @config.dict_add "OHAI"
+    @config.dict_add ["Foo", "Bar"]
+    assert_equal ["OHAI", "Foo", "Bar"], @config.dictionary
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: merimee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- coutud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: &70150877255760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70150877255760
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70150877255200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70150877255200
+description: Automatically submit your rendered views to AfterTheDeadline free spell
+  check service, and make sure you don't have any errors in your views !
+email:
+- wam@atwam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/merimee.rb
+- lib/merimee/after_the_deadline.rb
+- lib/merimee/checker.rb
+- lib/merimee/config.rb
+- lib/merimee/railties/merimee_railtie.rb
+- lib/merimee/rspec/view_checker_helper.rb
+- lib/merimee/version.rb
+- merimee.gemspec
+- test/checker_test.rb
+- test/config_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: merimee
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Add spell checking to your views tests/specs
+test_files:
+- test/checker_test.rb
+- test/config_test.rb