merimee 0.0.2 → 0.1.0

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Damien Couture
+
+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

@@ -10,34 +10,26 @@ _merimee_ adds some rspec macros (Test::Case to come ... maybe) to add automatic
 gem 'merimee'
 ```
 
-## Configuration
+## Usage
 
-The config object has the following methods/arguments :
+### Rspec/rails
+Just drop a `require 'merimee'` in your `spec_helper.rb`.
+It gives you the following in your views :
 
 ```ruby
-Merime::Checker.new do |config|
-  # 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 'OHAI' 
-  config.dict_add %w{Trealiu Chtulu} # Ignore other words, method takes any enumerable too !
-
-  # Ignore all words contained in blah.txt, one per line
-  config.dict_add_file 'blah.txt'
-
-  # English by default, but AfterTheDeadline also supports French(fr), Spanish(es), German(de), Portuguese(pt)
-  config.language = 'en' 
+describe 'splash/index' do
+  it_should_have_correct_spelling
+end
 
-  # 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' 
-  
-  # You can ignore some types of errors.
-  config.ignore_types << 'spelling' 
+# Which is equivalent to
+describe 'splash/logout' do
+  it "should have a correct spelling" do
+    render
+    rendered.should have_a_correct_spelling
+  end
 end
 ```
 
-## Usage
-
 ### Standalone use
 
 Well, you need to initalize a `Merimee::Checker` with a `Merimee::Config`
@@ -55,21 +47,32 @@ checker.check('This text has one BIGE error')
 
 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 :
+## Configuration
+
+The config object has the following methods/arguments :
 
 ```ruby
-describe 'splash/index' do
-  it_should_have_correct_spelling
-end
+Merime::Checker.new do |config|
+  # 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 'OHAI' 
+  config.dict_add %w{Trealiu Chtulu} # Ignore other words, method takes any enumerable too !
 
-# Which is equivalent to
-describe 'splash/logout' do
-  it "should have a correct spelling" do
-    render
-    rendered.should have_a_correct_spelling
-  end
+  # Ignore all words contained in blah.txt, one per line
+  config.dict_add_file 'blah.txt'
+
+  # English by default, but AfterTheDeadline also supports French(fr), Spanish(es), German(de), Portuguese(pt)
+  config.language = 'en' 
+
+  # 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' 
+  
+  # You can ignore some types of errors.
+  # Some are already ignored by default, see Merimee::DEFAULT_IGNORE_TYPES in lib/merimee/config.rb
+  config.ignore 'spelling', 'grammar'
+  # You can also include some types that were ignored
+  config.error 'cliches', 'double negatives'
 end
 ```
 
@@ -85,9 +88,24 @@ RSpec.configure do |config|
 end
 ```
 
+Or you can set your config in your test (for example to ignore just a word in one view) :
+
+```ruby
+describe "blah/index" do
+  it_should_have_correct_spelling do |config|
+    config.dict_add "mybrand"
+  end
+end
+```
+
 ## Known issues
 
 See http://github.com/coutud/merimee/issues
+Feel free to fork, send request (especially for Test::Case ... I'm a bit lazy for that).
+
+## License
+
+This gem is licensed under the MIT license. See LICENSE.md
 
 ## Thanks etc.
 

data/Rakefile

@@ -12,3 +12,5 @@ desc "Open an irb session preloaded with this library"
 task :console do
     sh "irb -rubygems -I lib -r merimee.rb"
 end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,3 @@
+
+* Allow for case sensitive/insensitive add in dictionary
+* Allow some error types to throw errors, and some to just output warnings

data/lib/merimee.rb

@@ -2,6 +2,7 @@ require "merimee/version"
 
 require "merimee/checker"
 require "merimee/config"
+require "merimee/error"
 require "merimee/after_the_deadline"
 
 require 'merimee/railties/merimee_railtie.rb' if defined?(Rails)

data/lib/merimee/after_the_deadline.rb

@@ -53,7 +53,7 @@ class AfterTheDeadline
   private_class_method :perform
 end
 
-class AfterTheDeadline::Error
+class AfterTheDeadline::Error < Merimee::Error
   attr_reader :string, :description, :precontext, :type, :suggestions, :url
 
   def initialize(hash)

data/lib/merimee/checker.rb

@@ -13,15 +13,18 @@ module Merimee
       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
+
+      # Remove any error types we don't care about
+      errors.each do |err|
+        err.severity = @config.severity[err.description.downcase] || :error
+      end
+
       errors
     end
 

data/lib/merimee/config.rb

@@ -1,12 +1,12 @@
 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_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
+    attr_accessor :dictionary
+    attr_reader :severity
     
     # This is required by the service for caching purposes,
     # but no registration is needed (api_key should just be unique for
@@ -20,11 +20,31 @@ module Merimee
 
     def initialize
       @dictionary = []
-      @ignore_types = Merimee::DEFAULT_IGNORE_TYPES
+      @severity = {}
+      ignore(Merimee::DEFAULT_IGNORE_TYPES)
+
       @api_key = Config.generate_api_key
       @language = Merimee::DEFAULT_LANGUAGE
     end
 
+    def ignore(types)
+      set_type_severity(types, :ignore)
+    end
+    def warn(types)
+      set_type_severity(types, :warn)
+    end
+    def error(types)
+      set_type_severity(types, :error)
+    end
+    def set_type_severity(types, level)
+      unless types.kind_of?(Enumerable)
+        types = [types]
+      end
+      types.each do |t|
+        @severity[t.to_s.downcase] = level
+      end
+    end
+
     def dict_add(word)
       if word.kind_of?(String)
         @dictionary << word
@@ -37,6 +57,15 @@ module Merimee
       File.open(file) {|f| dict_add(f.readlines.map(&:strip)) }
     end
 
+    def clone
+      ret = Config.new
+      ret.dictionary = @dictionary.dup
+      ret.severity.update(@severity)
+      ret.api_key = api_key
+      ret.language = language
+      ret
+    end
+
     private
     # We just use the path to this file, and the current hostname
     # If you

data/lib/merimee/error.rb

@@ -0,0 +1,5 @@
+module Merimee
+  class Error
+    attr_accessor :severity
+  end
+end

data/lib/merimee/rspec/view_checker_helper.rb

@@ -1,22 +1,28 @@
 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)
+      class HaveACorrectSpellingMatcher
+        def initialize
+          @config = ::RSpec.configuration.merimee_config
+          yield @config if block_given?
+        end
+
+        def matches?(rendered)
+          checker = Merimee::Checker.new(@config)
 
           if rendered
             @errors = checker.check(rendered)
-            @errors.empty?
+            @errors.none? {|e| e.severity == :error}
           else
             true
           end
         end
-        failure_message_for_should do |view|
+
+        def failure_message_for_should
           errs = []
-          @errors.each do |err|
-            message = "[#{err.type}] #{err.string}"
-            if err.suggestions
+          @errors.sort_by(&:severity).each do |err|
+            message = "[#{err.severity} : #{err.type} - #{err.description}] #{err.string}"
+            unless err.suggestions.empty?
               message << " (suggested: #{err.suggestions.join(', ')})"
             end
             errs << message
@@ -25,10 +31,10 @@ module Merimee
         end
       end
 
-      def it_should_have_a_correct_spelling
+      def it_should_have_a_correct_spelling(&block)
         it "should have a correct spelling" do
           render
-          rendered.should have_a_correct_spelling
+          rendered.should HaveACorrectSpellingMatcher.new(&block)
         end
       end
     end

data/lib/merimee/version.rb

@@ -1,3 +1,3 @@
 module Merimee
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/config_test.rb

@@ -6,8 +6,8 @@ class ConfigTest < MiniTest::Unit::TestCase
     @config = Merimee::Config.new
   end
 
-  def test_ignore_type_not_empty_by_default
-    refute_empty @config.ignore_types
+  def test_some_types_ignored_by_default
+    assert @config.severity.any? {|k,v| v == :ignore }
   end
 
   def test_add_dict_with_word

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merimee
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2012-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &70305273190660 !ruby/object:Gem::Requirement
+  requirement: &70137566869380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70305273190660
+  version_requirements: *70137566869380
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70305273190080 !ruby/object:Gem::Requirement
+  requirement: &70137566868820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70305273190080
+  version_requirements: *70137566868820
 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:
@@ -43,12 +43,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
+- TODO.md
 - lib/merimee.rb
 - lib/merimee/after_the_deadline.rb
 - lib/merimee/checker.rb
 - lib/merimee/config.rb
+- lib/merimee/error.rb
 - lib/merimee/railties/merimee_railtie.rb
 - lib/merimee/rspec/view_checker_helper.rb
 - lib/merimee/version.rb