style-scanner 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. data/.gitignore +19 -0
  2. data/.rspec +0 -0
  3. data/.rvmrc +1 -0
  4. data/Gemfile +4 -0
  5. data/Rakefile +16 -0
  6. data/bin/style +11 -0
  7. data/lib/dictionaries/acronyms.txt +5 -0
  8. data/lib/dictionaries/cliches.txt +680 -0
  9. data/lib/dictionaries/nationalities.txt +185 -0
  10. data/lib/style_scanner/problems/base.rb +45 -0
  11. data/lib/style_scanner/scanner.rb +67 -0
  12. data/lib/style_scanner/sentence.rb +61 -0
  13. data/lib/style_scanner/sentence_scans/adverb.rb +19 -0
  14. data/lib/style_scanner/sentence_scans/base.rb +70 -0
  15. data/lib/style_scanner/sentence_scans/broken_link.rb +27 -0
  16. data/lib/style_scanner/sentence_scans/capitalization.rb +57 -0
  17. data/lib/style_scanner/sentence_scans/cliche.rb +21 -0
  18. data/lib/style_scanner/sentence_scans/consecutively_repeated_word.rb +22 -0
  19. data/lib/style_scanner/sentence_scans/excess_white_space.rb +22 -0
  20. data/lib/style_scanner/sentence_scans/inappropriate_contraction.rb +20 -0
  21. data/lib/style_scanner/sentence_scans/latin_abbreviation.rb +38 -0
  22. data/lib/style_scanner/sentence_scans/passive_tense.rb +32 -0
  23. data/lib/style_scanner/sentence_scans/speaking_in_generalities.rb +17 -0
  24. data/lib/style_scanner/sentence_scans/spelling.rb +22 -0
  25. data/lib/style_scanner/sentence_scans/ugly_word.rb +17 -0
  26. data/lib/style_scanner/sentence_scans/used_word_already_in_sentence.rb +29 -0
  27. data/lib/style_scanner/sentence_scans/useless_word.rb +17 -0
  28. data/lib/style_scanner/string.rb +33 -0
  29. data/lib/style_scanner/tagged_word.rb +58 -0
  30. data/lib/style_scanner/tagger.rb +25 -0
  31. data/lib/style_scanner/version.rb +3 -0
  32. data/lib/style_scanner.rb +17 -0
  33. data/readme.textile +157 -0
  34. data/spec/fixtures/sample_text.txt +2 -0
  35. data/spec/fixtures/stylish/economist/economist-1.txt +29 -0
  36. data/spec/fixtures/stylish/economist/economist-2.txt +21 -0
  37. data/spec/fixtures/stylish/economist/economist-3.txt +9 -0
  38. data/spec/fixtures/stylish/economist/economist-4.txt +23 -0
  39. data/spec/fixtures/stylish/economist/economist-5.txt +15 -0
  40. data/spec/fixtures/stylish/economist/economist-6.txt +37 -0
  41. data/spec/integrations/command_line_spec.rb +41 -0
  42. data/spec/problems/base_spec.rb +38 -0
  43. data/spec/scanner_spec.rb +41 -0
  44. data/spec/sentence_scans/adverb_spec.rb +13 -0
  45. data/spec/sentence_scans/base_spec.rb +18 -0
  46. data/spec/sentence_scans/broken_link_spec.rb +18 -0
  47. data/spec/sentence_scans/capitalization_spec.rb +44 -0
  48. data/spec/sentence_scans/cliche_spec.rb +35 -0
  49. data/spec/sentence_scans/consecutively_repeated_word_spec.rb +26 -0
  50. data/spec/sentence_scans/excess_white_space_spec.rb +22 -0
  51. data/spec/sentence_scans/inappropriate_contraction_spec.rb +21 -0
  52. data/spec/sentence_scans/latin_abbreviation_spec.rb +34 -0
  53. data/spec/sentence_scans/passive_tense_spec.rb +138 -0
  54. data/spec/sentence_scans/speaking_in_generalities_spec.rb +15 -0
  55. data/spec/sentence_scans/spelling_spec.rb +16 -0
  56. data/spec/sentence_scans/ugly_word_spec.rb +29 -0
  57. data/spec/sentence_scans/used_word_already_in_sentence.rb +21 -0
  58. data/spec/sentence_scans/useless_word_spec.rb +14 -0
  59. data/spec/sentence_spec.rb +76 -0
  60. data/spec/spec_helper.rb +26 -0
  61. data/spec/string_spec.rb +30 -0
  62. data/spec/tagged_word_spec.rb +35 -0
  63. data/spec/tagger_spec.rb +14 -0
  64. data/style-scanner.gemspec +30 -0
  65. metadata +263 -0
data/.gitignore ADDED
@@ -0,0 +1,19 @@
1
+ *.gem
2
+ *.rbc
3
+ lib/dictionaries/en_US*
4
+ .bundle
5
+ .config
6
+ .yardoc
7
+ Gemfile.lock
8
+ InstalledFiles
9
+ _yardoc
10
+ coverage
11
+ doc/
12
+ lib/bundler/man
13
+ log/*
14
+ pkg
15
+ rdoc
16
+ spec/reports
17
+ test/tmp
18
+ test/version_tmp
19
+ tmp
data/.rspec ADDED
File without changes
data/.rvmrc ADDED
@@ -0,0 +1 @@
1
+ rvm 1.9.2-p180@style
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source :rubygems
2
+
3
+ # Specify your gem's dependencies in style.gemspec
4
+ gemspec
data/Rakefile ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
3
+
4
+ begin
5
+ require 'bundler/setup'
6
+ Bundler::GemHelper.install_tasks
7
+ rescue LoadError
8
+ puts 'although not required, bundler is recommened for running the tests'
9
+ end
10
+
11
+ task :default => :spec
12
+
13
+ require 'rspec/core/rake_task'
14
+ RSpec::Core::RakeTask.new do |t|
15
+ t.rspec_opts = ["--color", '--format doc']
16
+ end
data/bin/style ADDED
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env ruby
2
+ require "style-scanner"
3
+ options = Trollop::options do
4
+ opt :adverb, "Scans for Adverbs", :default => false
5
+ opt :html, "HTML input", :default => false
6
+ opt :textile, "Textile input", :default => false
7
+ opt :spellcheck, "Spell check", :default => false
8
+ end
9
+ puts "=> Scanning for spelling error and style problems. May take a minute.\n".green
10
+ puts ["Problem Type".red, "Original Sentence".green, "Offending Word".yellow].join(" | ")
11
+ StyleScanner::Scanner.new(ARGF.read, options).scan
@@ -0,0 +1,5 @@
1
+ aids
2
+ asap
3
+ usa
4
+ uk
5
+ un