yast-rake 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7830a04721a56df2b14ce21212821533565668ad
-  data.tar.gz: 91c065a28fc28c495923909f9c4802c7c7110643
+  metadata.gz: d21f098ea9abcb68f50188222c8db49635459f68
+  data.tar.gz: 0ad9c9c3b5e6dd035f6cab2931f3ffff0b504b6b
 SHA512:
-  metadata.gz: 90faa3ec75f651288d4f51a16b646c4398db609a5f1ee7d4d965f1c8090810fac559bdeb76157094368db6e0ca1200f10812682c075fb570587a018cbc349e2e
-  data.tar.gz: 429338e7cf63b77ee9ed584dc5316df016eefd60b5979d10626f212520397bf636bfe3229c2525a096161bfebad3ba4895ca56af82b4cbf99c0395d9cbedc1a7
+  metadata.gz: e827363e7edfb10fc8923590422e629a754f3135544ad084bdf4b140a6c6c2d64b07f60bce54ccca1d18402d80e971827a0a8851228e4f51ffd7e237fb85eb41
+  data.tar.gz: 08f63ec226bc118b21fdbd102e40f755fa74e5ec9fbd88534b5943b2b38757f7083c4c32083500eb30a8001605b3ae238fe0dff83c74563e4b259bb82f5b958c

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.2.0

data/lib/tasks/spellcheck.rake

@@ -0,0 +1,124 @@
+#--
+# 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.dict)
+#  - repository specific dictionary (.spell.dict in the root directory)
+#
+# The custom dictionaries contains one word per line.
+# 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

data/lib/yast/rake.rb

@@ -46,7 +46,8 @@ Yast::Tasks.configuration do |conf|
   conf.obs_project = "YaST:Head"
   conf.obs_sr_project = "openSUSE:Factory"
   conf.package_name = File.read("RPMNAME").strip if File.exists?("RPMNAME")
-  conf.version = Yast::Tasks.spec_version
+  conf.version = Yast::Tasks.spec_version if !Dir.glob("package/*.spec").empty?
+  conf.skip_license_check << /spell.dict$/ # skip license check for spelling dictionaries
 end
 
 # load own tasks

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: yast-rake
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Josef Reidinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: packaging_rake_tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 description: |
@@ -47,14 +47,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/yast/rake.rb
+- COPYING
+- VERSION
 - lib/tasks/install.rake
 - lib/tasks/pot.rake
+- lib/tasks/run.rake
+- lib/tasks/spellcheck.rake
 - lib/tasks/test_unit.rake
 - lib/tasks/version.rake
-- lib/tasks/run.rake
-- COPYING
-- VERSION
+- lib/yast/rake.rb
 homepage: http://github.org/openSUSE/yast-rake
 licenses:
 - LGPL v2.1
@@ -65,17 +66,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rake tasks providing basic work-flow for Yast development