dephine 0.1.1 → 0.2.0

data/README.md

@@ -2,6 +2,12 @@
 
 Google dictionary in terminal
 
+## Requirements
+
+  * Ruby (1.9)
+  * libncursesw5-dev
+  * [mpg123](http://www.mpg123.de/) (<b>it's not required for OS X</b>)
+
 ## Installation
 
 	$ gem install dephine
@@ -22,6 +28,14 @@ Google dictionary in terminal
 	  Used to indicate a range
 	    - he trains anything from seven to eight hours a day
 
+## Hot-keys
+
+  * Arrow keys.
+  * `Ctrl-n` / `j` to scroll down.
+  * `Ctrl-p` / `k` to scroll up.
+  * `p` to pronounce.
+  * `q` to quit.
+
 ## Contributing
 
 1. Fork it

data/bin/dephine

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), %w[.. lib])
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib]))
 require 'dephine'
 
 Dephine::CLI.start(ARGV)

data/dephine.gemspec

@@ -15,4 +15,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_dependency 'ncursesw', '~> 1.2.4'
 end

data/lib/dephine.rb

@@ -1,3 +1,4 @@
 require 'dephine/version'
 require 'dephine/dictionary'
 require 'dephine/cli'
+require 'dephine/tui'

data/lib/dephine/cli.rb

@@ -1,39 +1,104 @@
+require 'tempfile'
+
 module Dephine
+
+  # Public: Make a simple Command Line Interface.
+  # To use this class the 'start' class method should be called.
+  #
+  # Examples
+  #
+  #   CLI.start(ARGV)
+  #   # => nil
   class CLI
-    class << self
-      def start(args)
-        banner = []
-        banner << 'Dephine, Google dictionary in terminal'
-        banner << 'Usage: dephine [word]'
-
-        if args.empty?
-          puts banner.join("\n")
-        else
-          define(args[0])
-        end
+
+    # Public: Use cli arguments for running the application.
+    #
+    # Returns nothing.
+    def self.start(args)
+      banner = []
+      banner << 'Dephine, Google dictionary in terminal'
+      banner << 'Usage: dephine [word]'
+
+      if args.empty?
+        puts banner.join("\n")
+      else
+        define(args[0])
+      end
+    end
+
+    # Public: Cross-platform way of finding an executable in the $PATH.
+    #
+    #   which('ruby') #=> /usr/bin/ruby
+    def self.which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = "#{path}/#{cmd}#{ext}"
+          return exe if File.executable? exe
+        }
+      end
+      return nil
+    end
+
+    # Public: Play word pronunciation.
+    # This method uses either mpg123 or afplay to play the audio file.
+    #
+    # audio - The String that should be path of an audio file to be played.
+    def self.play(audio)
+      player = which('mpg123') || which('afplay')
+      system("#{player} #{audio} 2>/dev/null")
+    end
+
+    # Internal: Display definitions of a word.
+    #
+    # arg - The String that will be defined.
+    def self.define(arg)
+      word = Dephine::Dictionary.new(arg)
+
+      if word.meanings.empty?
+        abort("Word not found in the dictionary!")
       end
 
-      private
-      def define(arg)
-        word = Dephine::Dictionary.new(arg)
+      t = Dephine::TUI.new
+      t.puts arg
 
-        if word.meanings.empty?
-          abort("Word not found in the dictionary!")
+      word.meanings.each do |m|
+        t.puts
+        t.puts "#{m[:type].downcase} #{m[:phonetic]}"
+        m[:meanings].each do |d|
+          t.puts "  #{d[:text]}"
+          d[:examples].each do |eg|
+            t.puts "    - #{eg}"
+          end
+          t.puts
         end
+      end
 
-        puts arg
-        word.meanings.each do |m|
-          puts
-          puts "#{m[:type].downcase} #{m[:phonetic]}"
-          m[:meanings].each do |d|
-            puts "  #{d[:text]}"
-            d[:examples].each do |eg|
-              puts "    - #{eg}"
-            end
-            puts
+      if word.pronunciations.length > 0
+        # create tempfile
+        file = Tempfile.new('temp-pronunciation.mp3')
+
+        # download pronunciation mp3 and save to tempfile
+        File.open(file, "wb") do |saved_file|
+          open(word.pronunciations[0][:url], 'rb') do |read_file|
+            saved_file.write(read_file.read)
           end
         end
+        file.close()
+
+        # play tempfile
+        t.set_key 'p' do
+          play(file.path)
+        end
       end
+
+      t.close
+
+    end
+
+    class << self
+      private :define
     end
+
   end
 end

data/lib/dephine/dictionary.rb

@@ -4,7 +4,7 @@ require 'json'
 module Dephine
   class Dictionary
     # Public: Returns the Array meanings of the word.
-    attr_reader :meanings
+    attr_reader :meanings, :pronunciations
 
     # Public: Initialize some definitions of a word.
     #
@@ -13,6 +13,7 @@ module Dephine
       raise ArgumentError, "Word shouldn't be blank" if word.empty?
 
       @meanings = []
+      @pronunciations = []
       url = "https://www.google.com/dictionary/json?callback=define&q=#{word}&" \
       "sl=en&tl=en&restrict=pr%2Cde&client=te"
 
@@ -26,6 +27,15 @@ module Dephine
           meanings: []
         }
 
+        # add pronunciation
+        primary['terms'].each do |term|
+          if term['type'] == 'sound'
+            @pronunciations << {
+              url: term['text'],
+            }
+          end
+        end
+
         # add meanings
         primary['entries'][1..-1].each do |entry|
           @meanings[-1][:meanings] << {

data/lib/dephine/tui.rb

@@ -0,0 +1,170 @@
+require 'ncursesw'
+
+module Dephine
+
+  # Public: Terminal User Interface for making a simple UI.
+  # All methods are instance methods and should be called on an instance.
+  #
+  # Examples
+  #
+  #   t = TUI.new
+  #   t.puts 'it uses ncurses'
+  #   t.close
+  #   # => 'it uses ncurses'
+  class TUI
+    # Public: Initialize a terminal user interface.
+    def initialize
+      Ncurses.initscr
+      Ncurses.nonl
+      Ncurses.cbreak
+      Ncurses.noecho
+
+      @screen = Ncurses.stdscr
+      @screen.scrollok(true)
+      @screen.keypad(true)
+
+      @top = 0
+      @contexts = []
+      @callbacks = {}
+    end
+
+    def maxy
+      @screen.getmaxy
+    end
+
+    # Public: Add a String to an Array named 'contexts'.
+    # This method basically doesn't act like the built-in method 'puts',
+    # but values of 'contexts' will be printed.
+    #
+    # text - The String that will be pushed to an Array.
+    #
+    # Returns the contexts Array.
+    def puts(text = '')
+      @contexts << text
+    end
+
+    # Public: Move up the scroll.
+    #
+    # Returns true or fase.
+    def scroll_up
+      if @top > 0
+        @screen.scrl(-1)
+        @top -= 1
+        str = @contexts[@top]
+
+        if str
+          @screen.move(0, 0)
+          @screen.addstr(str)
+        end
+
+        true
+
+      else
+        false
+      end
+    end
+
+    # Public: Move down the scroll.
+    #
+    # Returns true or false.
+    def scroll_down
+      if @top + maxy < @contexts.length
+        @screen.scrl(1)
+        @top += 1
+        str = @contexts[@top + maxy - 1]
+
+        if str
+          @screen.move(maxy - 1, 0)
+          @screen.addstr(str)
+        end
+
+        true
+
+      else
+        false
+      end
+    end
+
+    # Internal: Set some hot-keys for performing basic things.
+    # Basic things are scroll up, scroll down and quit.
+    #
+    # Returns nothing.
+    def hotkeys
+      loop do
+        c = @screen.getch
+
+        case c
+        when Ncurses::KEY_DOWN, 14, 'j'.ord
+          scroll_down
+
+        when Ncurses::KEY_UP, 16, 'k'.ord
+          scroll_up
+
+        when Ncurses::KEY_NPAGE
+          (maxy - 2).times do
+            break if !scroll_down
+          end
+
+        when Ncurses::KEY_PPAGE
+          (maxy - 2).times do
+            break if !scroll_up
+          end
+
+        when Ncurses::KEY_LEFT
+          while scroll_up; end
+
+        when Ncurses::KEY_RIGHT
+          while scroll_down; end
+
+        when 'q'.ord
+          break
+
+        when @callbacks[c]
+          true
+
+        else
+          @screen.move(0, 0)
+          @screen.addstr("[unknown key `#{Ncurses.keyname(c)}'=#{c}] ")
+        end
+
+        @screen.move(0, 0)
+      end
+    end
+
+    # Public: Set a hot-key for calling a block.
+    #
+    # key   - The key to be set as a hot-key.
+    # block - The block to be called when pressing the key.
+    #
+    # Examples
+    #
+    #   set_key 'q' do
+    #     quit
+    #   end
+    #   # => nil
+    #
+    # Returns nothing.
+    def set_key(key, &block)
+      @callbacks[key.ord] = block
+    end
+
+    # Public: Close the created terminal user interface.
+    # This method should be called for closing the terminal user interface.
+    #
+    # Returns nothing.
+    def close
+      @contexts[0..maxy-1].each_with_index do |line, idx|
+        @screen.move(idx, 0)
+        @screen.addstr(line.to_s)
+      end
+
+      @screen.move(0, 0)
+      @screen.refresh
+      hotkeys
+      Ncurses.endwin
+    end
+
+    private :hotkeys
+
+  end
+end

data/lib/dephine/version.rb

@@ -1,3 +1,3 @@
 module Dephine
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dephine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
-dependencies: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ncursesw
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.4
 description: 
 email:
 - contact@s1n4.com
@@ -29,6 +45,7 @@ files:
 - lib/dephine.rb
 - lib/dephine/cli.rb
 - lib/dephine/dictionary.rb
+- lib/dephine/tui.rb
 - lib/dephine/version.rb
 homepage: http://s1n4.com/dephine
 licenses: []
@@ -50,9 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Google dictionary in terminal
 test_files: []
-has_rdoc: