mdspell 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 557ab534f964bbd18e0453ddcbe9561698441d5b
-  data.tar.gz: bb03a5b7f5a40b1e1fe689d383abd1a35a4ccaa8
+  metadata.gz: 167c31fb49e320ecb9a67cae141e171b806446ea
+  data.tar.gz: 209aa4bc10977836b2ab9458510fb798a3621d2b
 SHA512:
-  metadata.gz: 21066ee2957e17175a5c353dacd2d9aea1a0a7067ef83813fad211c4548705027867509cfed1a4195893840013e2e92986b9ab8a34ffe6f22c66c81bc3562299
-  data.tar.gz: c96d072fc81fb88d458807e34953dcae4c01f96d3ec997f8269e527025ee5f1b6b4f4216ce1a9ffc50875b25efdf26b97478e5510833b888cde9ddf0777ecb1f
+  metadata.gz: bd3666dcba329f752f9ce3f5c87ace2cbbbaea87a6613a124fae877823a2558302e905fa8f786eed2f9581e0de6256c18154b94103e1f6ab5da557dfe551b551
+  data.tar.gz: 7e5b5582be2cc45272e47586693ce108488e6d2b0bd66c8728cc27a254b75488a7a5310254138df3b04f4f81a909acf9c3e0a971d8d70de3a925897714b886bd

data/README.md

@@ -1,5 +1,6 @@
 # MdSpell
 
+[![Gem Version](https://badge.fury.io/rb/mdspell.svg)](http://badge.fury.io/rb/mdspell)
 [![Build Status](https://travis-ci.org/mtuchowski/mdspell.svg)](
 https://travis-ci.org/mtuchowski/mdspell)
 [![Code Climate](https://codeclimate.com/github/mtuchowski/mdspell/badges/gpa.svg)](

data/lib/mdspell.rb

@@ -1,9 +1,9 @@
+require_relative 'mdspell/version'
 require_relative 'mdspell/cli'
 require_relative 'mdspell/configuration'
 require_relative 'mdspell/spell_checker'
 require_relative 'mdspell/text_line'
 require_relative 'mdspell/typo'
-require_relative 'mdspell/version'
 
 require 'rainbow'
 
@@ -15,10 +15,12 @@ module MdSpell
 
     # Spell-check each file.
     cli.files.each do |filename|
-      verbose "Spell-checking #{filename}..."
+      spell_checker = SpellChecker.new(filename)
+
+      verbose "Spell-checking #{spell_checker.filename}..."
 
-      SpellChecker.new(filename).typos.each do |typo|
-        error "#{filename}:#{typo.line.location}: #{typo.word}"
+      spell_checker.typos.each do |typo|
+        error "#{spell_checker.filename}:#{typo.line.location}: #{typo.word}"
       end
     end
   end

data/lib/mdspell/cli.rb

@@ -8,16 +8,14 @@ module MdSpell
     banner "Usage: #{File.basename($PROGRAM_NAME)} [options] [FILE.md|DIR ...]"
 
     option :config_file,
-           short: '-c',
+           short: '-c FILE',
            long: '--config FILE',
-           description: 'The configuration file to use',
-           default: '~/.mdspell'
+           description: 'The configuration file to use'
 
     option :language,
-           short: '-l',
+           short: '-l LANG',
            long: '--language LANG',
-           description: 'Set documents language',
-           default: 'en_US'
+           description: 'Set documents language'
 
     option :verbose,
            short: '-v',
@@ -35,11 +33,15 @@ module MdSpell
            exit: 0
 
     def run(argv = ARGV)
+      fail ArgumentError, 'expected Array of command line options' unless argv.is_a? Array
+
       parse_options(argv)
 
       # Load optional config file if it's present.
-      config_filename = File.expand_path(config[:config_file])
-      MdSpell::Configuration.from_file(config_filename) if File.exist?(config_filename)
+      if config[:config_file]
+        config_filename = File.expand_path(config[:config_file])
+        MdSpell::Configuration.from_file(config_filename) if File.exist?(config_filename)
+      end
 
       # Store command line configuration options.
       MdSpell::Configuration.merge!(config)
@@ -53,6 +55,7 @@ module MdSpell
         end
       end
       cli_arguments.flatten!
+      cli_arguments
     end
   end
 end

data/lib/mdspell/configuration.rb

@@ -4,5 +4,12 @@ module MdSpell
   # Stores configuration from both command line and config file.
   class Configuration
     extend Mixlib::Config
+
+    config_strict_mode true
+
+    default :config_file, '~/.mdspell'
+    default :language, 'en_US'
+    default :verbose, false
+    default :version, VERSION
   end
 end

data/lib/mdspell/spell_checker.rb

@@ -15,8 +15,15 @@ module MdSpell
     # Create a new instance from specified file.
     # @param filename [String] a name of file to load.
     def initialize(filename)
-      @filename = filename
-      @document = Kramdown::Document.new(File.read(filename), input: 'GFM')
+      if filename == '-'
+        @filename = 'stdin'
+        text = STDIN.read
+      else
+        @filename = filename
+        text = File.read(filename)
+      end
+
+      @document = Kramdown::Document.new(text, input: 'GFM')
     end
 
     # Returns found spelling errors.

data/lib/mdspell/version.rb

@@ -1,3 +1,6 @@
+# rubocop:disable Style/Documentation
+
 module MdSpell
-  VERSION = '0.1.0'
+  # Current version
+  VERSION = '0.1.1'
 end

data/spec/examples.cache

@@ -1,39 +1,58 @@
 example_id                                    | status  | run_time        |
 --------------------------------------------- | ------- | --------------- |
-./spec/mdspell/spell_checker_spec.rb[1:1:1]   | passed  | 0.00141 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:1:2]   | passed  | 0.00088 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:1:3]   | passed  | 0.00055 seconds |
+./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/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/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.00048 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:2:3]   | failed  | 0.01636 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:3:1]   | passed  | 0.03322 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:3:2:1] | failed  | 0.00015 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:4:1]   | passed  | 0.00181 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:5:1]   | failed  | 0.00789 seconds |
-./spec/mdspell/spell_checker_spec.rb[1:5:2]   | passed  | 0.00703 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:5:3]   | pending | 0.00001 seconds |
-./spec/mdspell/text_line_spec.rb[1:1:1]       | passed  | 0.00007 seconds |
-./spec/mdspell/text_line_spec.rb[1:1:2]       | passed  | 0.00008 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.0004 seconds  |
-./spec/mdspell/text_line_spec.rb[1:3:1]       | passed  | 0.00008 seconds |
-./spec/mdspell/text_line_spec.rb[1:4:1]       | passed  | 0.00009 seconds |
-./spec/mdspell/text_line_spec.rb[1:5:1]       | passed  | 0.0001 seconds  |
-./spec/mdspell/text_line_spec.rb[1:6:1]       | passed  | 0.00014 seconds |
-./spec/mdspell/text_line_spec.rb[1:6:2:1]     | passed  | 0.00008 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: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.00009 seconds |
-./spec/mdspell/text_line_spec.rb[1:7:1]       | passed  | 0.00012 seconds |
-./spec/mdspell/text_line_spec.rb[1:7:2]       | passed  | 0.00086 seconds |
-./spec/mdspell/typo_spec.rb[1:1:1]            | passed  | 0.00011 seconds |
-./spec/mdspell/typo_spec.rb[1:1: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.00012 seconds |
-./spec/mdspell/typo_spec.rb[1:2:2]            | passed  | 0.00016 seconds |
+./spec/mdspell/typo_spec.rb[1:2:1]            | passed  | 0.00097 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.00044 seconds |
-./spec/mdspell/typo_spec.rb[1:4:1]            | passed  | 0.00007 seconds |
-./spec/mdspell/typo_spec.rb[1:5:1]            | passed  | 0.00008 seconds |
-./spec/mdspell/typo_spec.rb[1:5:2]            | passed  | 0.0001 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 |

data/spec/examples/mdspell.config

@@ -0,0 +1 @@
+language 'pl'

data/spec/mdspell/cli_spec.rb

@@ -0,0 +1,50 @@
+describe MdSpell::CLI do
+  it { is_expected.to respond_to :run }
+  it { is_expected.to respond_to :files }
+
+  after(:all) do
+    MdSpell::Configuration.reset
+  end
+
+  context '#run' do
+    it 'should expect command line options array' do
+      [nil, 'string', 42].each do |argument|
+        expect do
+          subject.run(argument)
+        end.to raise_error ArgumentError, 'expected Array of command line options'
+      end
+    end
+  end
+
+  context '#files' do
+    context 'if single file given' do
+      it 'should return its path' do
+        subject.run(['README.md'])
+        expect(subject.files).to have(1).item
+
+        expect(subject.files[0]).to eq 'README.md'
+      end
+    end
+
+    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 include('spec/examples/with_errors.md')
+        expect(subject.files).to include('spec/examples/simple.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 include('spec/examples/with_errors.md')
+        expect(subject.files).to include('spec/examples/simple.md')
+        expect(subject.files).to include('README.md')
+      end
+    end
+  end
+end

data/spec/mdspell/configuration_spec.rb

@@ -0,0 +1,98 @@
+describe MdSpell::Configuration do
+  before(:each) do
+    MdSpell::Configuration.reset
+  end
+
+  after(:all) do
+    MdSpell::Configuration.reset
+  end
+
+  def run_app(args = [])
+    MdSpell::CLI.new.run(args)
+  end
+
+  context ':config_file' do
+    it "should default to '~/.mdspell'" do
+      run_app
+      expect(MdSpell::Configuration[:config_file]).to eq '~/.mdspell'
+    end
+
+    context 'command line argument' do
+      it "uses '-c' short flag" do
+        run_app(['-c', 'short'])
+        expect(MdSpell::Configuration[:config_file]).to eq 'short'
+      end
+
+      it "uses '--config' long flag" do
+        run_app(['--config', 'long'])
+        expect(MdSpell::Configuration[:config_file]).to eq 'long'
+      end
+    end
+
+    context 'if file exists' do
+      it 'should merge its content' do
+        run_app(['-c', 'spec/examples/mdspell.config'])
+        expect(MdSpell::Configuration[:language]).to eq 'pl'
+      end
+    end
+  end
+
+  context ':language' do
+    it "should default to 'en_US'" do
+      run_app
+      expect(MdSpell::Configuration[:language]).to eq 'en_US'
+    end
+
+    context 'command line argument' do
+      it "uses '-l' short flag" do
+        run_app(['-l', 'en_GB'])
+        expect(MdSpell::Configuration[:language]).to eq 'en_GB'
+      end
+
+      it "uses '--language' long flag" do
+        run_app(['--language', 'uk'])
+        expect(MdSpell::Configuration[:language]).to eq 'uk'
+      end
+    end
+  end
+
+  context ':verbose' do
+    it 'should default to false' do
+      run_app
+      expect(MdSpell::Configuration[:verbose]).to eq false
+    end
+
+    context 'command line argument' do
+      it "uses '-v' short flag" do
+        run_app(['-v'])
+        expect(MdSpell::Configuration[:verbose]).to eq true
+      end
+
+      it "uses '--verbose' long flag" do
+        run_app(['--verbose'])
+        expect(MdSpell::Configuration[:verbose]).to eq true
+      end
+    end
+  end
+
+  context ':version' do
+    it 'should return proper string' do
+      run_app
+      expect(MdSpell::Configuration[:version]).to eq MdSpell::VERSION
+    end
+
+    context 'command line argument' do
+      it "uses '-V' short flag" do
+        expect do
+          run_app(['-V'])
+        end.to raise_error SystemExit
+      end
+
+      it "uses '--version' long flag" do
+        expect do
+          run_app(['--version'])
+        end.to raise_error SystemExit
+      end
+    end
+  end
+end

data/spec/mdspell/spell_checker_spec.rb

@@ -37,7 +37,7 @@ describe MdSpell::SpellChecker do
 
     context 'if initialized from stdin' do
       it "should return 'stdin'" do
-        expect(stdin_md.filename).to eq 'stdin'
+        expect(from_stdin.filename).to eq 'stdin'
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdspell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marek Tuchowski
@@ -57,8 +57,11 @@ files:
 - lib/mdspell/typo.rb
 - lib/mdspell/version.rb
 - spec/examples.cache
+- spec/examples/mdspell.config
 - spec/examples/simple.md
 - spec/examples/with_errors.md
+- spec/mdspell/cli_spec.rb
+- spec/mdspell/configuration_spec.rb
 - spec/mdspell/spell_checker_spec.rb
 - spec/mdspell/text_line_spec.rb
 - spec/mdspell/typo_spec.rb
@@ -92,7 +95,10 @@ summary: A Ruby markdown spell checking tool.
 test_files:
 - spec/spec_helper.rb
 - spec/examples/with_errors.md
+- spec/examples/mdspell.config
 - spec/examples/simple.md
+- spec/mdspell/configuration_spec.rb
+- spec/mdspell/cli_spec.rb
 - spec/mdspell/text_line_spec.rb
 - spec/mdspell/typo_spec.rb
 - spec/mdspell/spell_checker_spec.rb