mdspell 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 167c31fb49e320ecb9a67cae141e171b806446ea
-  data.tar.gz: 209aa4bc10977836b2ab9458510fb798a3621d2b
+  metadata.gz: e9afcdac3d5c1ed898a1880ab4dd0bc55db5bfcf
+  data.tar.gz: 4eb4112a9edacb8f50bf8423562fb4bc64ae0472
 SHA512:
-  metadata.gz: bd3666dcba329f752f9ce3f5c87ace2cbbbaea87a6613a124fae877823a2558302e905fa8f786eed2f9581e0de6256c18154b94103e1f6ab5da557dfe551b551
-  data.tar.gz: 7e5b5582be2cc45272e47586693ce108488e6d2b0bd66c8728cc27a254b75488a7a5310254138df3b04f4f81a909acf9c3e0a971d8d70de3a925897714b886bd
+  metadata.gz: 599cacde11b6f1d60958d3cc4413de5c88e4e7f0c90a27050d57efb6421007d3031fb8effeeeb88a3e6278e87ae5cb3bee15bca03538955af1e296f435d4da35
+  data.tar.gz: 495d0c7eede2b7dcfc871bf198fecdc29a640e8045006dec254c3622e8a73ac28ddd1673b4572e4ea429757e6e081ceb8ccfff2916e2169543a31fe656153a03

data/README.md

@@ -15,7 +15,16 @@ A Ruby markdown spell checking tool.
 To install from [rubygems.org](http://rubygems.org/), run:
 
 ```console
-gem install mdspell
+$ gem install mdspell
+```
+
+On top of that, make sure that [GNU Aspell](http://aspell.net/) is installed on the system:
+
+```console
+# Ubuntu
+$ sudo apt-get install aspell
+# Arch Linux
+$ sudo pacman -S aspell
 ```
 
 ## Usage
@@ -23,19 +32,18 @@ gem install mdspell
 To spell-check markdown files, simply run `mdspell` with the filenames as a parameter:
 
 ```console
-mdspell README.md
+$ mdspell README.md
 ```
 
 To check all markdown files within the directory:
 
 ```console
-mdspell docs/
+$ mdspell docs/
 ```
 
 For each spelling error found, MdSpell will display the misspelled word, filename and line number:
 
 ```console
-Spell-checking ./README.md...
 ./README.md:10: actualy
 ```
 

data/lib/mdspell/version.rb

@@ -2,5 +2,5 @@
 
 module MdSpell
   # Current version
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/examples.cache

@@ -1,58 +1,58 @@
 example_id                                    | status  | run_time        |
 --------------------------------------------- | ------- | --------------- |
-./spec/mdspell/cli_spec.rb[1:1]               | passed  | 0.0001 seconds  |
-./spec/mdspell/cli_spec.rb[1:2]               | passed  | 0.00012 seconds |
-./spec/mdspell/cli_spec.rb[1:3:1]             | passed  | 0.00016 seconds |
-./spec/mdspell/cli_spec.rb[1:4:1:1]           | passed  | 0.00041 seconds |
-./spec/mdspell/cli_spec.rb[1:4:2:1]           | passed  | 0.00054 seconds |
-./spec/mdspell/cli_spec.rb[1:4:3:1]           | passed  | 0.00111 seconds |
-./spec/mdspell/configuration_spec.rb[1:1:1]   | passed  | 0.00033 seconds |
-./spec/mdspell/configuration_spec.rb[1:1:2:1] | passed  | 0.00038 seconds |
-./spec/mdspell/configuration_spec.rb[1:1:2:2] | passed  | 0.00034 seconds |
-./spec/mdspell/configuration_spec.rb[1:1:3:1] | passed  | 0.00055 seconds |
+./spec/mdspell/cli_spec.rb[1:1]               | passed  | 0.00011 seconds |
+./spec/mdspell/cli_spec.rb[1:2]               | passed  | 0.00029 seconds |
+./spec/mdspell/cli_spec.rb[1:3:1]             | passed  | 0.00039 seconds |
+./spec/mdspell/cli_spec.rb[1:4:1:1]           | passed  | 0.00059 seconds |
+./spec/mdspell/cli_spec.rb[1:4:2:1]           | passed  | 0.00166 seconds |
+./spec/mdspell/cli_spec.rb[1:4:3:1]           | passed  | 0.00058 seconds |
+./spec/mdspell/configuration_spec.rb[1:1:1]   | passed  | 0.00032 seconds |
+./spec/mdspell/configuration_spec.rb[1:1:2:1] | passed  | 0.00035 seconds |
+./spec/mdspell/configuration_spec.rb[1:1:2:2] | passed  | 0.00037 seconds |
+./spec/mdspell/configuration_spec.rb[1:1:3:1] | passed  | 0.0006 seconds  |
 ./spec/mdspell/configuration_spec.rb[1:2:1]   | passed  | 0.00034 seconds |
-./spec/mdspell/configuration_spec.rb[1:2:2:1] | passed  | 0.00035 seconds |
-./spec/mdspell/configuration_spec.rb[1:2:2:2] | passed  | 0.00038 seconds |
-./spec/mdspell/configuration_spec.rb[1:3:1]   | passed  | 0.00071 seconds |
-./spec/mdspell/configuration_spec.rb[1:3:2:1] | passed  | 0.00037 seconds |
-./spec/mdspell/configuration_spec.rb[1:3:2:2] | passed  | 0.00035 seconds |
-./spec/mdspell/configuration_spec.rb[1:4:1]   | passed  | 0.00033 seconds |
-./spec/mdspell/configuration_spec.rb[1:4:2:1] | passed  | 0.00043 seconds |
-./spec/mdspell/configuration_spec.rb[1:4:2:2] | passed  | 0.00044 seconds |
+./spec/mdspell/configuration_spec.rb[1:2:2:1] | passed  | 0.00033 seconds |
+./spec/mdspell/configuration_spec.rb[1:2:2:2] | passed  | 0.00037 seconds |
+./spec/mdspell/configuration_spec.rb[1:3:1]   | passed  | 0.00037 seconds |
+./spec/mdspell/configuration_spec.rb[1:3:2:1] | passed  | 0.00034 seconds |
+./spec/mdspell/configuration_spec.rb[1:3:2:2] | passed  | 0.00036 seconds |
+./spec/mdspell/configuration_spec.rb[1:4:1]   | passed  | 0.00087 seconds |
+./spec/mdspell/configuration_spec.rb[1:4:2:1] | passed  | 0.00048 seconds |
+./spec/mdspell/configuration_spec.rb[1:4:2:2] | passed  | 0.00153 seconds |
 ./spec/mdspell/spell_checker_spec.rb[1:1:1]   | passed  | 0.00059 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:1:2]   | passed  | 0.0006 seconds  |
-./spec/mdspell/spell_checker_spec.rb[1:1:3]   | passed  | 0.00066 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:2:1]   | passed  | 0.00014 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:2:2]   | passed  | 0.00035 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:2:3]   | passed  | 0.0005 seconds  |
-./spec/mdspell/spell_checker_spec.rb[1:3:1]   | passed  | 0.00116 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:3:2:1] | passed  | 0.00074 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:4:1]   | passed  | 0.03383 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:5:1]   | passed  | 0.01874 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:5:2]   | passed  | 0.00913 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:1:2]   | passed  | 0.00065 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:1:3]   | passed  | 0.00053 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:2:1]   | passed  | 0.00016 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:2:2]   | passed  | 0.00012 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:2:3]   | passed  | 0.00055 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:3:1]   | passed  | 0.00094 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:3:2:1] | passed  | 0.00663 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:4:1]   | passed  | 0.00446 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:5:1]   | passed  | 0.01128 seconds |
+./spec/mdspell/spell_checker_spec.rb[1:5:2]   | passed  | 0.0238 seconds  |
 ./spec/mdspell/spell_checker_spec.rb[1:5:3]   | pending | 0.00001 seconds |
-./spec/mdspell/text_line_spec.rb[1:1:1]       | passed  | 0.00008 seconds |
-./spec/mdspell/text_line_spec.rb[1:1:2]       | passed  | 0.00009 seconds |
-./spec/mdspell/text_line_spec.rb[1:1:3]       | passed  | 0.00007 seconds |
-./spec/mdspell/text_line_spec.rb[1:1:4]       | passed  | 0.00007 seconds |
-./spec/mdspell/text_line_spec.rb[1:2:1]       | passed  | 0.00013 seconds |
+./spec/mdspell/text_line_spec.rb[1:1:1]       | passed  | 0.0001 seconds  |
+./spec/mdspell/text_line_spec.rb[1:1:2]       | passed  | 0.00038 seconds |
+./spec/mdspell/text_line_spec.rb[1:1:3]       | passed  | 0.00008 seconds |
+./spec/mdspell/text_line_spec.rb[1:1:4]       | passed  | 0.00009 seconds |
+./spec/mdspell/text_line_spec.rb[1:2:1]       | passed  | 0.00017 seconds |
 ./spec/mdspell/text_line_spec.rb[1:3:1]       | passed  | 0.00007 seconds |
 ./spec/mdspell/text_line_spec.rb[1:4:1]       | passed  | 0.00007 seconds |
-./spec/mdspell/text_line_spec.rb[1:5:1]       | passed  | 0.0004 seconds  |
-./spec/mdspell/text_line_spec.rb[1:6:1]       | passed  | 0.00015 seconds |
-./spec/mdspell/text_line_spec.rb[1:6:2:1]     | passed  | 0.00039 seconds |
-./spec/mdspell/text_line_spec.rb[1:6:3:1]     | passed  | 0.00011 seconds |
-./spec/mdspell/text_line_spec.rb[1:6:3:2]     | passed  | 0.0001 seconds  |
-./spec/mdspell/text_line_spec.rb[1:6:4:1]     | passed  | 0.00043 seconds |
-./spec/mdspell/text_line_spec.rb[1:7:1]       | passed  | 0.00011 seconds |
-./spec/mdspell/text_line_spec.rb[1:7:2]       | passed  | 0.00094 seconds |
-./spec/mdspell/typo_spec.rb[1:1:1]            | passed  | 0.00052 seconds |
-./spec/mdspell/typo_spec.rb[1:1:2]            | passed  | 0.00009 seconds |
-./spec/mdspell/typo_spec.rb[1:1:3]            | passed  | 0.00008 seconds |
-./spec/mdspell/typo_spec.rb[1:2:1]            | passed  | 0.00097 seconds |
+./spec/mdspell/text_line_spec.rb[1:5:1]       | passed  | 0.00014 seconds |
+./spec/mdspell/text_line_spec.rb[1:6:1]       | passed  | 0.00017 seconds |
+./spec/mdspell/text_line_spec.rb[1:6:2:1]     | passed  | 0.00009 seconds |
+./spec/mdspell/text_line_spec.rb[1:6:3:1]     | passed  | 0.00038 seconds |
+./spec/mdspell/text_line_spec.rb[1:6:3:2]     | passed  | 0.00011 seconds |
+./spec/mdspell/text_line_spec.rb[1:6:4:1]     | passed  | 0.00009 seconds |
+./spec/mdspell/text_line_spec.rb[1:7:1]       | passed  | 0.00018 seconds |
+./spec/mdspell/text_line_spec.rb[1:7:2]       | passed  | 0.04916 seconds |
+./spec/mdspell/typo_spec.rb[1:1:1]            | passed  | 0.00008 seconds |
+./spec/mdspell/typo_spec.rb[1:1:2]            | passed  | 0.00011 seconds |
+./spec/mdspell/typo_spec.rb[1:1:3]            | passed  | 0.00074 seconds |
+./spec/mdspell/typo_spec.rb[1:2:1]            | passed  | 0.00018 seconds |
 ./spec/mdspell/typo_spec.rb[1:2:2]            | passed  | 0.00013 seconds |
 ./spec/mdspell/typo_spec.rb[1:2:3]            | passed  | 0.00014 seconds |
-./spec/mdspell/typo_spec.rb[1:3:1]            | passed  | 0.00042 seconds |
-./spec/mdspell/typo_spec.rb[1:4:1]            | passed  | 0.00016 seconds |
-./spec/mdspell/typo_spec.rb[1:5:1]            | passed  | 0.00028 seconds |
-./spec/mdspell/typo_spec.rb[1:5:2]            | passed  | 0.00034 seconds |
+./spec/mdspell/typo_spec.rb[1:3:1]            | passed  | 0.00059 seconds |
+./spec/mdspell/typo_spec.rb[1:4:1]            | passed  | 0.00008 seconds |
+./spec/mdspell/typo_spec.rb[1:5:1]            | passed  | 0.00048 seconds |
+./spec/mdspell/typo_spec.rb[1:5:2]            | passed  | 0.00012 seconds |

data/spec/examples/complete.md

@@ -0,0 +1,31 @@
+# First header
+
+## Second Header
+
+### Third Header
+
+#### Fourth Header
+
+##### Fifth Header
+
+First paragraph
+
+Second paragraph
+
+Multi-line
+paragraph
+
+> Block-quote
+
+> Another block-quote
+>
+> > Nested block-quote
+
+* Unordered
+* List
+
+1. Ordered
+1. List
+
+* Multi-line paragraph
+  as list item

data/spec/mdspell/cli_spec.rb

@@ -29,21 +29,23 @@ describe MdSpell::CLI do
     context 'if directory given' do
       it 'should return all markdown files in that directory' do
         subject.run(['spec/examples'])
-        expect(subject.files).to have(2).item
+        expect(subject.files).to have(3).item
 
-        expect(subject.files).to include('spec/examples/with_errors.md')
         expect(subject.files).to include('spec/examples/simple.md')
+        expect(subject.files).to include('spec/examples/complete.md')
+        expect(subject.files).to include('spec/examples/with_errors.md')
       end
     end
 
     context 'if both directory and single file given' do
       it 'should return all files' do
         subject.run(['README.md', 'spec/examples'])
-        expect(subject.files).to have(3).item
+        expect(subject.files).to have(4).item
 
-        expect(subject.files).to include('spec/examples/with_errors.md')
-        expect(subject.files).to include('spec/examples/simple.md')
         expect(subject.files).to include('README.md')
+        expect(subject.files).to include('spec/examples/simple.md')
+        expect(subject.files).to include('spec/examples/complete.md')
+        expect(subject.files).to include('spec/examples/with_errors.md')
       end
     end
   end

data/spec/mdspell/text_line_spec.rb

@@ -92,20 +92,37 @@ describe MdSpell::TextLine do
   end
 
   context '::scan' do
-    let(:simple_md) { Kramdown::Document.new(File.read('spec/examples/simple.md'), input: 'GFM') }
+    let(:complete_md) do
+      Kramdown::Document.new(File.read('spec/examples/complete.md'), input: 'GFM')
+    end
 
     it 'should expect Kramdown::Document as argument' do
       expect { MdSpell::TextLine.scan }. to raise_error ArgumentError
     end
 
     it 'should find proper lines' do
-      lines = MdSpell::TextLine.scan(simple_md)
-
-      expect(lines).to have(3).items
-
-      expect(lines[0].content).to eq 'Simple'
-      expect(lines[1].content).to eq 'markdown'
-      expect(lines[2].content).to eq 'file'
+      lines = MdSpell::TextLine.scan(complete_md)
+
+      expect(lines).to have(18).items
+
+      expect(lines[0].content).to eq 'First header'
+      expect(lines[1].content).to eq 'Second Header'
+      expect(lines[2].content).to eq 'Third Header'
+      expect(lines[3].content).to eq 'Fourth Header'
+      expect(lines[4].content).to eq 'Fifth Header'
+      expect(lines[5].content).to eq 'First paragraph'
+      expect(lines[6].content).to eq 'Second paragraph'
+      expect(lines[7].content).to eq 'Multi-line'
+      expect(lines[8].content).to eq 'paragraph'
+      expect(lines[9].content).to eq 'Block-quote'
+      expect(lines[10].content).to eq 'Another block-quote'
+      expect(lines[11].content).to eq 'Nested block-quote'
+      expect(lines[12].content).to eq 'Unordered'
+      expect(lines[13].content).to eq 'List'
+      expect(lines[14].content).to eq 'Ordered'
+      expect(lines[15].content).to eq 'List'
+      expect(lines[16].content).to eq 'Multi-line paragraph'
+      expect(lines[17].content).to eq 'as list item'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdspell
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Marek Tuchowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -57,6 +57,7 @@ files:
 - lib/mdspell/typo.rb
 - lib/mdspell/version.rb
 - spec/examples.cache
+- spec/examples/complete.md
 - spec/examples/mdspell.config
 - spec/examples/simple.md
 - spec/examples/with_errors.md
@@ -96,6 +97,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/examples/with_errors.md
 - spec/examples/mdspell.config
+- spec/examples/complete.md
 - spec/examples/simple.md
 - spec/mdspell/configuration_spec.rb
 - spec/mdspell/cli_spec.rb