yast-rake 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bbb403c890ab6c775bd9a4e0c1fc520ab44a379
-  data.tar.gz: 2fd864fc0b84fb7f789904a5207f4ee37967197b
+  metadata.gz: 6064a1a8380fe02784d5f7009d4c700aa8d7980c
+  data.tar.gz: 12db5b4793732221de0f81a7e94941e66d7d825d
 SHA512:
-  metadata.gz: 6535a53fdd8007a0013f716937d71e6964beb7ffa129caad0ca0e128a8f960700696e3451d179d4aa33835b980d69527b09f111283f6b497d5a8fcf8ca697691
-  data.tar.gz: db261d5f3eb90a4b7150a5fdfa278882aab810db42c3dad8634771bc2f91adc4ac82e0441114ab01ecb55e3c23580222c79c0696a87b8a4a42f6279118461a13
+  metadata.gz: aeb3e3082628dc89e9c39c794f2eaba7914ff167de09d33fbed35289beb22027a39b9f95f309d3f8163cd4018e1af431e0e35755804a12634aa44e3a09b56e3e
+  data.tar.gz: eba47c56dda60084cd00e3dc6e447c289250d0554a6f384176c1179a928bc7564243b0c9acfb4aa8f96860e0e19a9a160d969cfdff931c021a18988a6f4f5fa6

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/tasks/spell.yml

@@ -0,0 +1,50 @@
+# This is the global spellcheck config shared by all YaST repositories.
+
+---
+check:
+  - "**/*.html"
+  - "**/*.md"
+ignore: []
+dictionary:
+  #
+  # Notes: Write the words in alphabetical order, if an unknown word
+  # is not generic put it into the repository specific dictionary.
+  #
+  - API
+  - bnc
+  - boolean
+  - Bugzilla
+  - devel
+  - DHCP
+  - freenode
+  - gh
+  - GitHub
+  - GitHub's
+  - html
+  - IRC
+  - LDAP
+  - md
+  - NCurses
+  - NFS
+  - NIS
+  - openSUSE
+  - osc
+  - Rakefile
+  - rb
+  - refactorings
+  - RSpec
+  - runlevel
+  - SCR
+  - SLP
+  - sudo
+  - SUSE
+  - systemd
+  - testsuite
+  - UI
+  - WFM
+  - workflow
+  - yast
+  - YaST
+  - ycp
+  - YCP
+  - zypper

data/lib/tasks/spellcheck.rake

@@ -28,97 +28,5 @@
 # The lines starting with '#' character are ignored (used for comments),
 #
 
-GLOBAL_DICTIONARY_FILE = "spell.dict"
-CUSTOM_DICTIONARY_FILE = ".spell.dict"
-
-def read_dictionary_file(file)
-  puts "Loading custom dictionary (#{file})..." if verbose == true
-  words = File.read(file).split("\n")
-
-  # remove comments
-  words.reject! { |word| word.start_with?("#")}
-  words.each(&:chomp!)
-end
-
-# read the global and the repository custom dictionary
-def read_custom_words
-  # read the global default custom dictionary
-  dict_path = File.expand_path("../#{GLOBAL_DICTIONARY_FILE}", __FILE__)
-  custom_words = read_dictionary_file(dict_path)
-
-  # read the custom dictionary from the project directory if present
-  dict_path = CUSTOM_DICTIONARY_FILE
-  if File.exist?(dict_path)
-    local_dict = read_dictionary_file(dict_path)
-    duplicates = custom_words & local_dict
-
-    if !duplicates.empty?
-      $stderr.puts "Warning: Found duplicates in the local dictionary (#{dict_path}):\n"
-      duplicates.each {|duplicate| $stderr.puts "  #{duplicate}" }
-      $stderr.puts
-    end
-
-    custom_words += local_dict - duplicates
-  end
-
-  custom_words
-end
-
-def aspell_speller
-  # raspell is an optional dependency, handle the missing case nicely
-  begin
-    require "raspell"
-  rescue LoadError
-    $stderr.puts "ERROR: Ruby gem \"raspell\" is not installed."
-    exit 1
-  end
-
-  # initialize aspell
-  speller = Aspell.new("en_US")
-  speller.suggestion_mode = Aspell::NORMAL
-  # ignore the HTML tags in the text
-  speller.set_option("mode", "html")
-
-  speller
-end
-
-namespace :check do
-  desc "Run spell checker (by default for *.md and *.html files in Git)"
-  task :spelling, :regexp do |t, args|
-    regexp = args[:regexp] || /\.(md|html)\z/
-    success = true
-
-    files = `git ls-files . | grep -v \\.gitignore`.split("\n")
-    files.select!{|file| file.match(regexp)}
-
-    custom_words = read_custom_words
-    speller = aspell_speller
-
-    files.each do |file|
-      puts "Checking #{file}..." if verbose == true
-      # spell check each line separately so we can report error locations properly
-      lines = File.read(file).split("\n")
-
-      lines.each_with_index do |text, index|
-        misspelled = speller.list_misspelled([text]) - custom_words
-
-        if !misspelled.empty?
-          success = false
-          puts "#{file}:#{index + 1}: #{text.inspect}"
-          misspelled.each do |word|
-            puts "    #{word.inspect} => #{speller.suggest(word)}"
-          end
-          puts
-        end
-      end
-    end
-
-    if success
-      puts "Spelling OK."
-    else
-      $stderr.puts "Spellcheck failed! (Fix it or add the words to " \
-        "'#{CUSTOM_DICTIONARY_FILE}' file if it is OK.)"
-      exit 1
-    end
-  end
-end
+require_relative "spellcheck_task"
+Yast::SpellcheckTask.new

data/lib/tasks/spellcheck_task.rb

@@ -0,0 +1,170 @@
+#--
+# Yast rake
+#
+# Copyright (C) 2015 Novell, Inc.
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+#
+# Rake task for checking spelling in the documentation files.
+# By default checks all *.md and *.html files.
+#
+# Supports custom dictionaries:
+#
+#  - global dictionary located in the tasks gem (lib/tasks/spell.yml)
+#  - repository specific dictionary (.spell.yml in the root directory)
+#
+# The custom dictionaries are defined at the "dictionary" key.
+#
+
+require 'rake'
+require 'rake/tasklib'
+
+module Yast
+  # Defines a spellcheck rake task
+  class SpellcheckTask < Rake::TaskLib
+    GLOBAL_SPELL_CONFIG_FILE = File.expand_path("../spell.yml", __FILE__)
+    CUSTOM_SPELL_CONFIG_FILE = ".spell.yml"
+
+    # define the Rake task in the constructor
+    def initialize
+      namespace :check do
+        desc "Run spell checker (by default for *.md and *.html files)"
+        task :spelling do
+          run_task
+        end
+      end
+
+    end
+
+    private
+
+    # optionally colorize the misspelled words if the rainbow gem is present
+    # @return [Boolean] true when the colorization support is present
+    def colorize?
+      return @colorize unless @colorize.nil?
+
+      begin
+        require "rainbow"
+        @colorize = true
+      rescue LoadError
+        @colorize = false
+      end
+    end
+
+    # create an Aspell speller object
+    # @return [Aspell] the speller object
+    def speller
+      return @speller if @speller
+      # raspell is an optional dependency, handle the missing case nicely
+      begin
+        require "raspell"
+      rescue LoadError
+        $stderr.puts "ERROR: Ruby gem \"raspell\" is not installed."
+        exit 1
+      end
+
+      # initialize aspell
+      @speller = Aspell.new("en_US")
+      @speller.suggestion_mode = Aspell::NORMAL
+      # ignore the HTML tags in the text
+      @speller.set_option("mode", "html")
+
+      @speller
+    end
+
+    # evaluate the files to check
+    # @return [Array<String>] list of files
+    def files_to_check
+      files = config["check"].reduce([]) {|acc, glob| acc + Dir[glob]}
+      config["ignore"].reduce(files) {|acc, glob| acc - Dir[glob]}
+    end
+
+    # read a Yaml config file
+    def read_spell_config(file)
+      return {} unless File.exist?(file)
+
+      puts "Loading config file (#{file})..." if verbose == true
+      require "yaml"
+      YAML.load_file(file)
+    end
+
+    # print the duplicate dictionary entries
+    # @param dict1 [Array<String>] the first dictionary
+    # @param dict2 [Array<String>] the second dictionary
+    def report_duplicates(dict1, dict2)
+      duplicates = dict1 & dict2
+      return if duplicates.empty?
+
+      $stderr.puts "Warning: Found dictionary duplicates in the local dictionary " \
+        "(#{CUSTOM_SPELL_CONFIG_FILE}):\n"
+      duplicates.each {|duplicate| $stderr.puts "  #{duplicate}" }
+      $stderr.puts
+    end
+
+    # return the merged global and the custom spell configs
+    # @return [Hash] the merged configuration to use
+    def config
+      return @config if @config
+
+      @config = read_spell_config(GLOBAL_SPELL_CONFIG_FILE)
+      custom_config = read_spell_config(CUSTOM_SPELL_CONFIG_FILE)
+
+      report_duplicates(config["dictionary"], custom_config["dictionary"].to_a)
+
+      custom_config["dictionary"] = @config["dictionary"] + custom_config["dictionary"].to_a
+      custom_config["dictionary"].uniq!
+
+      # override the global values by the local if present
+      @config.merge!(custom_config)
+
+      @config
+    end
+
+    # check the file using the spellchecker
+    # @param file [String] file name
+    # @return [Boolean] true on success (no spelling error found)
+    def check_file(file)
+      puts "Checking #{file}..." if verbose == true
+      # spell check each line separately so we can report error locations properly
+      lines = File.read(file).split("\n")
+
+      success = true
+      lines.each_with_index do |text, index|
+        misspelled = speller.list_misspelled([text]) - config["dictionary"]
+        next if misspelled.empty?
+
+        success = false
+        misspelled.each {|word| text.gsub!(word, Rainbow(word).red)} if colorize?
+        puts "#{file}:#{index + 1}: \"#{text}\""
+
+        misspelled.each { |word| puts "    #{word.inspect} => #{speller.suggest(word)}" }
+        puts
+      end
+
+      success
+    end
+
+    # run the task
+    def run_task
+      if files_to_check.all? { |file| check_file(file) }
+        puts "Spelling OK."
+      else
+        $stderr.puts "Spellcheck failed! (Fix it or add the words to " \
+          "'#{CUSTOM_SPELL_CONFIG_FILE}' file if it is OK.)"
+        exit 1
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yast-rake
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Josef Reidinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,8 +52,9 @@ files:
 - lib/tasks/install.rake
 - lib/tasks/pot.rake
 - lib/tasks/run.rake
-- lib/tasks/spell.dict
+- lib/tasks/spell.yml
 - lib/tasks/spellcheck.rake
+- lib/tasks/spellcheck_task.rb
 - lib/tasks/test_unit.rake
 - lib/tasks/version.rake
 - lib/yast/rake.rb

data/lib/tasks/spell.dict

@@ -1,43 +0,0 @@
-# This is the global custom dictionary shared with all YaST repositories.
-#
-# Write the words in alphabetical order, one word per line.
-# If an unknown word is not generic put it into the repository specific dictionary.
-#
-API
-bnc
-boolean
-Bugzilla
-devel
-DHCP
-freenode
-gh
-GitHub
-GitHub's
-html
-IRC
-LDAP
-md
-NCurses
-NFS
-NIS
-openSUSE
-osc
-Rakefile
-rb
-refactorings
-RSpec
-runlevel
-SCR
-SLP
-sudo
-SUSE
-systemd
-testsuite
-UI
-WFM
-workflow
-yast
-YaST
-ycp
-YCP
-zypper