clispell 0.2.2 → 0.3.0

data/Rakefile

@@ -18,6 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.add_dependency 'dmarkow-raspell'
   gem.add_dependency 'mattscilipoti-rdialog'
   gem.add_dependency 'oald_parser'
+  gem.add_dependency 'clipboard'
   gem.executables = ['clispell']
   gem.homepage = "http://github.com/ip2k/clispell"
   gem.license = "Creative Commons by-nc-sa"

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/bin/clispell

@@ -1,12 +1,39 @@
 #!/usr/bin/env ruby
+# ---- REQUIRED GEMS ----
 require 'raspell'
 require 'mattscilipoti-rdialog'
 require 'oald_parser'
 
+# ---- FLAGS AND GLOBAL VARS ----
+
+# set this to true if we want to automatically copy the...
+# ...correctly spelled word to the clipboard.
+# NOTE: Requires the 'xclip' binary on Linux.
+$enable_copy_to_clipboard = true
+
+# ---- INIT LOGIC ----
+
+# if we're enabling the clipboard functionality, require the 'clipboard' gem.
+if $enable_copy_to_clipboard
+    require 'clipboard'
+    # if we're running on Linux, make sure that 'xclip' is available...
+    # ...and quit if it isn't since clipboard won't work without it.
+    if RUBY_PLATFORM.include?("linux")
+        xclip = `which xclip`.strip
+        if xclip.empty?
+            abort("You need the 'xclip' binary for copy-to-clipboard functionality to work properly under Linux")
+        end
+    end
+end
+
+
+# ---- METHODS ----
+
 # helper method for instantiating our ASpell API...
 # using this, you only have to configure it in one spot.
 def new_speller()
-    # instantiate our speller and set the dict to en_US (English - United States) and ignore cAsE.
+    # instantiate our speller and set the dict to en_US...
+    # ...(English - United States) and ignore cAsE.
     speller = Aspell.new("en_US")
     speller.set_option("ignore-case", "true")
     return speller
@@ -15,7 +42,8 @@ end
 # helper method for instantiating our dialog API...
 # using this, you only have to configure it in one spot.
 def new_dialog()
-    # instantiate our dialog and set some options
+    # instantiate our dialog and set some options...
+    # ...then return it as an object
     dialog = RDialog.new
     dialog.nocancel = true
     dialog.shadow = false
@@ -24,11 +52,14 @@ end
 
 # look up a word in the Oxford Advanced Learners Dictionary
 def define_word(someword)
+    # use the Facade interface from the oald_parser gem...
+    # ...which does the scraping / parsing for us.
+    puts "Waiting for the definition of #{someword} (requires internet access)..."
     facade = OaldParser::Facade.create_configured_instance
     return facade.describe(str: someword)
 end
 
-# our method to see if a word is spelled correctly
+# check the spelling of a word and return boolean.
 def check_spelling(someword)
     myspeller = new_speller()
     # test [someword] for spelling error and return true if it's correct.
@@ -39,22 +70,37 @@ def check_spelling(someword)
     end
 end
 
+# copy [something] to the clipboard (works on OSX/Linux/Win)...
+# ...if we have the flag set to enable that.
+def copy_to_clipboard(something)
+    if $enable_copy_to_clipboard
+        Clipboard.copy(something)
+        puts "Copied #{something} to the clipboard."
+    end
+end
+
+# get an array of possible corrections.
 def get_suggestions(someword)
     myspeller = new_speller()
     return myspeller.suggest(someword)
 end
 
+# show a dialog menu with all the possible corrections
 def show_suggestion_array(orig_word,suggestions)
     # use our new_dialog helper method and call the menu() method on it...
     # ...with our fancy text and suggestions array, then...
     # ...block until the user picks something and return what they picked.
-    return new_dialog.menu("#{orig_word} not found or spelled incorrectly.  Select a word below view the definition.", suggestions)
+    return new_dialog.menu("#{orig_word} not found or spelled incorrectly.\nSelect a word below view the definition.", suggestions)
 end
 
+# show a dialog box with the definition.
 def show_definition(definition)
     return new_dialog.msgbox(definition)
 end
 
+
+# ---- MAIN ----
+
 # if the user didn't pass any args, abort and let them know that they need to.
 if ARGV.first.nil?
     abort("You must specify a word that you want to spell check or define")
@@ -62,9 +108,14 @@ else
     # if the user spelled the word right, just show the definition...
     # and tell them they were right while we're waiting on the API.
     if check_spelling(ARGV.first)
-        puts "#{ARGV.first} is spelled correctly, waiting for the definition (requires internet access)..."
+
+        # if we're copying stuff to the clipboard, copy the correct spelling.
+        copy_to_clipboard(ARGV.first)
+        puts "#{ARGV.first} is spelled correctly."
+
+        # get and display the definition, then end.
         definition = define_word(ARGV.first)
-        show_definition("#{ARGV.first}:\n#{definition}")
+        show_definition("#{ARGV.first} is spelled correctly.\n\n#{ARGV.first}:\n#{definition}")
         exit(0)
     else
         # get possible words if the user sends us a typo'd word.
@@ -76,6 +127,11 @@ else
 
         # call our show_suggestion_array method with the array-of-arrays.
         user_selection_string = show_suggestion_array(ARGV.first, suggestions_array)
+
+        # if we're copying stuff to the clipboard, copy what the user picks.
+        copy_to_clipboard(user_selection_string)
+
+        # get and display the definition of the word the user picks, then end.
         definition = define_word(user_selection_string)
         show_definition("#{user_selection_string}:\n#{definition}")
         exit(0)

data/clispell.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{clispell}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ip2k"]
-  s.date = %q{2011-07-31}
+  s.date = %q{2011-08-01}
   s.default_executable = %q{clispell}
   s.description = %q{clispell provides an easy-to-use CLI that harnesses ASpell the Oxford Advanced Learner's Dictionary and delivers pretty word info FAST right to your terminal}
   s.email = %q{github@seanp2k.endjunk.com}
@@ -27,7 +27,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/clispell",
-    "clispell.gemspec"
+    "clispell.gemspec",
+    "lib/clipboard_example.rb"
   ]
   s.homepage = %q{http://github.com/ip2k/clispell}
   s.licenses = ["Creative Commons by-nc-sa"]
@@ -46,6 +47,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<dmarkow-raspell>, [">= 0"])
       s.add_runtime_dependency(%q<mattscilipoti-rdialog>, [">= 0"])
       s.add_runtime_dependency(%q<oald_parser>, [">= 0"])
+      s.add_runtime_dependency(%q<clipboard>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -54,6 +56,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<dmarkow-raspell>, [">= 0"])
       s.add_dependency(%q<mattscilipoti-rdialog>, [">= 0"])
       s.add_dependency(%q<oald_parser>, [">= 0"])
+      s.add_dependency(%q<clipboard>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
@@ -63,6 +66,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<dmarkow-raspell>, [">= 0"])
     s.add_dependency(%q<mattscilipoti-rdialog>, [">= 0"])
     s.add_dependency(%q<oald_parser>, [">= 0"])
+    s.add_dependency(%q<clipboard>, [">= 0"])
   end
 end
 

data/lib/clipboard_example.rb

@@ -0,0 +1,18 @@
+# set this to true if we want to automatically copy the...
+# ...correctly spelled word to the clipboard.
+# NOTE: Requires the 'xclip' binary on Linux.
+enable_copy_to_clipboard = true
+
+if enable_copy_to_clipboard
+    require 'clipboard'
+    # if we're running on Linux, make sure that 'xclip' is available...
+    # ...and quit if it isn't since clipboard won't work without it.
+    if RUBY_PLATFORM.include?("linux")
+        xclip = `which xclip`.strip
+        if xclip.empty?
+            abort("You need the 'xclip' binary for copy-to-clipboard functionality to work properly under Linux")
+        end
+    end
+    Clipboard.copy("test123")
+    puts Clipboard.paste
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clispell
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-31 00:00:00.000000000 -04:00
+date: 2011-08-01 00:00:00.000000000 -04:00
 default_executable: clispell
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &75982320 !ruby/object:Gem::Requirement
+  requirement: &80047820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75982320
+  version_requirements: *80047820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &75982080 !ruby/object:Gem::Requirement
+  requirement: &80047580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *75982080
+  version_requirements: *80047580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &75981840 !ruby/object:Gem::Requirement
+  requirement: &80047340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *75981840
+  version_requirements: *80047340
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &75981600 !ruby/object:Gem::Requirement
+  requirement: &80047100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75981600
+  version_requirements: *80047100
 - !ruby/object:Gem::Dependency
   name: dmarkow-raspell
-  requirement: &75981360 !ruby/object:Gem::Requirement
+  requirement: &80046860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75981360
+  version_requirements: *80046860
 - !ruby/object:Gem::Dependency
   name: mattscilipoti-rdialog
-  requirement: &75981120 !ruby/object:Gem::Requirement
+  requirement: &80046620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75981120
+  version_requirements: *80046620
 - !ruby/object:Gem::Dependency
   name: oald_parser
-  requirement: &75980880 !ruby/object:Gem::Requirement
+  requirement: &80046380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75980880
+  version_requirements: *80046380
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: &80046140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80046140
 description: clispell provides an easy-to-use CLI that harnesses ASpell the Oxford
   Advanced Learner's Dictionary and delivers pretty word info FAST right to your terminal
 email: github@seanp2k.endjunk.com
@@ -108,6 +119,7 @@ files:
 - VERSION
 - bin/clispell
 - clispell.gemspec
+- lib/clipboard_example.rb
 has_rdoc: true
 homepage: http://github.com/ip2k/clispell
 licenses:
@@ -124,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 346098287
+      hash: -777866863
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: