cmdline-fu 0.1.2 → 0.1.3

data/Manifest

@@ -4,3 +4,4 @@ README.md
 Rakefile
 VERSION
 bin/cmdline-fu
+example/dot.cmdline-fu.conf

data/README.md

@@ -6,22 +6,58 @@ commandlinefu is community based repository for usefull commandline such as one-
 This script scrape available TAG from site's top page with `hpricot` for supporting query based on TAG.  
 TAGS file are stored to `~/.cmdline-fu.tags`. 
 
-`o` option depends on `open` command of OSX(means supported only on MacOS). 
+Install
+----------------------------------
+gem install cmdline-fu
 
-## Install:
 
-    gem install cmdline-fu
+Sample Configuration("~/.cmdline-fu.conf")
+----------------------------------
+    {
+      #--------------------------------------------------------
+      # Proxy setting. you can overwrite this 
+      # with HTTP_PROXY environment variable
+      #--------------------------------------------------------
+      # :http_proxy_  => 'http://192.168.1.1:3128',
 
-##  Usage
+      #--------------------------------------------------------
+      # Disable colorized output
+      #--------------------------------------------------------
+      #:colorize     => false,
 
-    cmdline-fu COMMAND [PAGE] [o]
+      #--------------------------------------------------------
+      # Supported colors are...
+      #  black red green yellow blue magenta cyan white
+      #--------------------------------------------------------
+      :color_match  => 'yellow',
+      :color_desc   => 'cyan',
+      :color_footer => 'green',
+
+      #--------------------------------------------------------
+      # Web Browser command used such as 'cmdline-fu browse o'.
+      #--------------------------------------------------------
+      # for linux
+      :browse_cmd   => 'firefox',
+      # :browse_cmd   => 'google-chrome',
+      
+      # Mac OSX's default
+      # :browse_cmd   => 'open',
+    }
+
+Usage
+----------------------------------
+
+    cmdline-fu COMMAND [PAGE] [o] [-n]
     
       COMMAND: list_tag [MATCHER], browse, using WORD, by USER, tagged TAG, matching WORD
       PAGE: 1-999 (defaut: 1)
-      o: 'o'pen in browser
-
-##  Example
+      o:    open in browser
+      -n:   not colorize
 
+Example
+----------------------------------
+  
+    cmdline-fu renew_tag
     cmdline-fu list_tag
     cmdline-fu list_tag vm
     cmdline-fu browse
@@ -31,9 +67,11 @@ TAGS file are stored to `~/.cmdline-fu.tags`.
     cmdline-fu tagged install
     cmdline-fu matching find
 
-##  Abbreviation
+Abbreviation
+----------------------------------
     Unique abbreviation for command is supported.
 
+    cmdline-fu r
     cmdline-fu l
     cmdline-fu l vm
     cmdline-fu br

data/Rakefile

@@ -10,5 +10,5 @@ Echoe.new "cmdline-fu", File.read("./VERSION").chomp do |p|
   p.rubyforge_name = nil
   p.url = "http://github.com/t9md/cmdline-fu"
   p.runtime_dependencies << 'colored'
-  p.runtime_dependencies << 'hpricot >=0.8.2'
+  # p.runtime_dependencies << 'hpricot >=0.8.2'
 end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/bin/cmdline-fu

@@ -1,15 +1,10 @@
 #!/usr/bin/env ruby
 
 require "rubygems"
-require 'net/http'
+require "net/http"
 require "ostruct"
 require "abbrev"
 
-begin
-  require "colored"
-rescue LoadError
-end
-
 # Example
 # browse/sort-by-votes - All commands sorted by votes
 # tagged/163/grep - Commands tagged with 'grep', sorted by date (the default sort order)
@@ -18,100 +13,153 @@ end
 # api_comand_set = [ :browse, :tagged, :matching ]
 # api_format = [ :plaintext, :json, :rss ]
 # api_url = "http://www.commandlinefu.com/commands/<command-set>/<format>/"
+
+def try_require(lib, msg=nil)
+  begin
+    require lib
+  rescue LoadError => e
+    warn "can't load #{lib}: #{e}"
+    warn "\n#{msg}\n"
+  end
+end
+
+try_require "colored"
   
 class CommandLineFu
   API_URL     = 'http://www.commandlinefu.com/commands'
 
-  # attr_reader :api_url
+  DEFAULT_OPT = {
+    :page            => 1,
+    :command         => "browse",
+    :format          => "plaintext",
+    :sort_order      => "sort-by-votes",
+    :tag_file        => "~/.cmdline-fu.tags",
+    :tag_expire_days => 3,
+    :open_browser    => false,
+    :colorize        => true,
+    # 'black'   => 30,
+    # 'red'     => 31,
+    # 'green'   => 32,
+    # 'yellow'  => 33,
+    # 'blue'    => 34,
+    # 'magenta' => 35,
+    # 'cyan'    => 36,
+    # 'white'   => 37
+    :color_match  => 'yellow',
+    :color_desc   => 'cyan',
+    :color_footer => 'green'
+  }
+
+  attr_reader :opt
+  def initialize(user_opt)
+    @opt = OpenStruct.new(DEFAULT_OPT.update(user_config).update(user_opt))
+    # p @opt
+    # exit
+  end
 
-  def initialize user_opt
-    @opt        = OpenStruct.new($default_opt.update(user_opt))
-    @command    = @opt.command
-    @format     = @opt.format
-    @sort_order = @opt.sort_order
-    unless @command == "list_tag"
-      build_url
+  def user_config
+    user_config = File.expand_path "~/.cmdline-fu.conf"
+    if File.exist? user_config
+      return(eval File.read(user_config))
+    else
+      return {}
     end
   end
 
   def result
-    return list_tag if @command == "list_tag"
-
-
-    page_idx = (@opt.page - 1) * 25
-    url = @api_url + "/#{page_idx}"
+    if %w(list_tag renew_tag version).include? opt.command
+      return send(opt.command)
+    end
+    page_idx = (opt.page - 1) * 25
 
-    if @opt.open_browser
-      system("open '#{url}'")
+    url = "#{api_url}/#{page_idx}"
+    if opt.open_browser
+      system("#{browse_cmd} '#{url}'")
       return
     end
+
     result = open_url(url)
-    return "#{@opt.search} NOT FOUND" if result.code != "200"
+    return "#{opt.search} NOT FOUND" if result.code != "200"
 
     # each entry is separated by blank line , and we need to -1 for page headers.
     b = result.body.split("\n\n")
     header = b.shift
     num_of_entries = b.size
     body = b.join("\n\n")
+
     unless num_of_entries.zero?
-      body = (defined?(Colored) ? colorize(body) : body)
-      body << "\n\n## Page(#{@opt.page}):#{page_idx}-#{page_idx+num_of_entries} #{url}".green
-      body << "\n##{header}".green
+      footer = "\n\n## Page(#{opt.page}):#{page_idx}-#{page_idx+num_of_entries} #{url}\n#{header}"
+      p opt.colorize
+      if opt.colorize
+        body   = colorize(body)
+        footer = footer.send(opt.color_footer)
+      end
+      body + footer
     end
-    body
   end
 
   def open_url(url)
-    uri = URI.parse(url)
-    http = Net::HTTP.new(uri.host, uri.port)
+    Net::HTTP.version_1_2
+    uri     = URI.parse(url)
+    proxy   = URI.parse(ENV['HTTP_PROXY'] || opt.http_proxy_|| "")
+    http    = Net::HTTP::Proxy(proxy.host, proxy.port).start(uri.host, uri.port)
     request = Net::HTTP::Get.new(uri.request_uri)
     http.request(request)
   end
   
   private
-  def build_url
-    command_part = send("setup_#{@command}")
-    @api_url = "#{API_URL}/%s/%s" % [command_part, @sort_order ]
-    @api_url += "/#{@format}" if @format
-  end
-
-  def setup_browse
-    "#{@command}"
+  def browse_cmd
+    return opt.browse_cmd if opt.browse_cmd
+    case RUBY_PLATFORM.downcase
+    when /darwin/ then "open"
+    when /linux/  then "firefox"
+    when /mswin/  then 'echo "NOT SUPPORTED for browse command"'
+    end
   end
 
-  def setup_using
-    "#{@command}/#{@opt.search}"
+  def api_url
+    command_part = command_set_for(opt.command)
+    url = "#{API_URL}/#{command_part}/#{opt.sort_order}"
+    url << "/#{opt.format}" if opt.format
+    url
   end
-  alias_method :setup_by, :setup_using
 
-  def setup_matching
-    b64text = [@opt.search].pack("m").chomp
-    search = @opt.search.tr(' ','-')
-    "#{@command}/#{search}/#{b64text}"
+  def command_set_for(command)
+    { 
+      "version"  => "version",
+      "browse"   => "browse",
+      "using"    => "using/#{opt.search}",
+      "by"       => "by/#{opt.search}",
+      "matching" => lambda {
+        b64text = [opt.search].pack("m").chomp
+        search  = opt.search.tr(' ','-')
+        "matching/#{search}/#{b64text}"
+      }.call,
+      "tagged" => lambda {
+        unless tag_id = tags[opt.search]
+          raise "Tag not found"
+        end
+        "tagged/#{tag_id}/#{opt.search}"
+      }.call
+    }[command]
   end
 
-  def setup_tagged
-    tag = @opt.search
-    tag_id = tags[tag]
-    raise "Tag not found" unless tag_id
-    "#{@command}/#{tag_id}/#{tag}"
+  def version
+     return File.read(File.dirname(File.expand_path(__FILE__)) + "/../VERSION" )
   end
 
   def colorize(string)
     string.split("\n").map do |e|
       e.chomp!
-      (e =~ /^#/) ? e.blue : e.gsub(/#{@opt.search}/){|m| Colored.colorize m, :foreground => 'magenta' }
+      (e =~ /^#/) ? e.send(opt.color_desc) :
+        e.gsub(/#{opt.search}/){|m|
+        Colored.colorize m, :foreground => opt.color_match
+      }
     end.join("\n")
   end
 
-  def tag_file_is_too_old?
-    tag_file = File.expand_path @opt.tag_file
-    expire_limit = (60 * 60 * 24) * @opt.tag_expire_days
-    expire_limit < (Time.now - File.stat(tag_file).mtime)
-  end
-
   def list_tag
-    candidate = tags.keys.grep(/#{@opt.search}/)
+    candidate = tags.keys.grep(/#{opt.search}/)
     result = if candidate.size >= 1
                colorize(candidate.join("\n"))
              elsif candidate.size == 0
@@ -125,10 +173,11 @@ class CommandLineFu
   end
 
   def build_tag_file
-    tag_file = File.expand_path @opt.tag_file
-    h = extract_tag
-    File.open(tag_file, "wb"){ |f| Marshal.dump(h, f) }
+    tag_file = File.expand_path opt.tag_file
+    File.open(tag_file, "wb"){ |f| Marshal.dump(scrape_tag, f) }
+    return
   end
+  alias_method :renew_tag, :build_tag_file
 
   # def extract_tag_nokogiri
     # require 'nokogiri'
@@ -144,8 +193,17 @@ class CommandLineFu
     # h
   # end
 
-  def extract_tag
-    require "hpricot"
+  def scrape_tag
+    ret = try_require "hpricot", <<-EOS
+
+    if you want to TAG based query, install 'hpricot'
+
+      gem install hpricot
+
+    EOS
+    unless ret
+      exit
+    end
     h = {}
     url = 'http://www.commandlinefu.com/commands/browse'
     Hpricot(open_url(url).body).
@@ -160,15 +218,13 @@ class CommandLineFu
   end
 
   def load_tags
-    tag_file = File.expand_path @opt.tag_file
-    if not File.exist?(tag_file) or tag_file_is_too_old? or $NOCACHE
-      build_tag_file
+    tag_file = File.expand_path opt.tag_file
+    unless File.exist?(tag_file)
+      build_tag_file 
     end
     File.open(tag_file, "rb"){ |f| Marshal.load f }
   end
-
 end
-# $NOCACHE = true
 
 # TEST
 # [
@@ -181,26 +237,10 @@ end
   # puts CommandLineFu.new(opt).api_url
 # end
 
-$default_opt = {
-  :page            => 1,
-  :command         => "browse",
-  :format          => "plaintext",
-  :sort_order      => "sort-by-votes",
-  :tag_file        => "~/.cmdline-fu.tags",
-  :tag_expire_days => 3,
-  :open_browser    => false,
-}
-
-command_table = Abbrev.abbrev(%w(list_tag browse using by tagged matching))
-
-# user_opt = {}
-# ARGV = %w(browse)
-# ARGV = %w(using find)
-# ARGV = %w(by atoponce)
-# ARGV = %w(matching find)
-
+command_table = Abbrev.abbrev(%w(list_tag browse using by tagged matching renew_tag version))
 
 user_opt = {}
+user_opt[:colorize] = false if ARGV.delete('-n')
 user_opt[:command] = command_table[ARGV.shift]
 
 if ARGV.last == 'o'
@@ -213,21 +253,22 @@ page = ARGV.last.to_i
 user_opt[:page]  = page.zero? ? 1 :  page
 user_opt[:search]  = ARGV.shift
 
-
 PROGRAM_NAME = File.basename $0
 if user_opt[:command].nil?
   puts <<-EOS
 
   #{"Usage".bold}
 
-    #{PROGRAM_NAME} COMMAND [PAGE] [o]
+    #{PROGRAM_NAME} COMMAND [PAGE] [o] [-n]
     
       COMMAND: list_tag [MATCHER], browse, using WORD, by USER, tagged TAG, matching WORD
       PAGE: 1-999 (defaut: 1)
-      o: 'o'pen in browser
+      o:    open in browser
+      -n:   not colorize
 
   #{"Example".bold}
 
+    #{PROGRAM_NAME} renew_tag
     #{PROGRAM_NAME} list_tag
     #{PROGRAM_NAME} list_tag vm
     #{PROGRAM_NAME} browse
@@ -240,6 +281,7 @@ if user_opt[:command].nil?
   #{"Abbreviation".bold}
     Unique abbreviation for command is supported.
 
+    #{PROGRAM_NAME} r
     #{PROGRAM_NAME} l
     #{PROGRAM_NAME} l vm
     #{PROGRAM_NAME} br

data/cmdline-fu.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cmdline-fu}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["t9md"]
-  s.date = %q{2010-12-29}
+  s.date = %q{2011-01-22}
   s.default_executable = %q{cmdline-fu}
   s.description = %q{CLI frontend for http://www.commandlinefu.com/ }
   s.email = %q{taqumd@gmail.com}
   s.executables = ["cmdline-fu"]
   s.extra_rdoc_files = ["LICENSE.txt", "README.md", "bin/cmdline-fu"]
-  s.files = ["LICENSE.txt", "Manifest", "README.md", "Rakefile", "VERSION", "bin/cmdline-fu", "cmdline-fu.gemspec"]
+  s.files = ["LICENSE.txt", "Manifest", "README.md", "Rakefile", "VERSION", "bin/cmdline-fu", "example/dot.cmdline-fu.conf", "cmdline-fu.gemspec"]
   s.homepage = %q{http://github.com/t9md/cmdline-fu}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Cmdline-fu", "--main", "README.md"]
   s.require_paths = ["lib"]
@@ -25,13 +25,10 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<colored>, [">= 0"])
-      s.add_runtime_dependency(%q<hpricot>, [">= 0.8.2"])
     else
       s.add_dependency(%q<colored>, [">= 0"])
-      s.add_dependency(%q<hpricot>, [">= 0.8.2"])
     end
   else
     s.add_dependency(%q<colored>, [">= 0"])
-    s.add_dependency(%q<hpricot>, [">= 0.8.2"])
   end
 end

data/example/dot.cmdline-fu.conf

@@ -0,0 +1,30 @@
+{
+  #--------------------------------------------------------
+  # Proxy setting. you can overwrite this 
+	# with HTTP_PROXY environment variable
+  #--------------------------------------------------------
+	# :http_proxy_  => 'http://192.168.1.1:3128',
+
+  #--------------------------------------------------------
+  # Disable colorized output
+  #--------------------------------------------------------
+	#:colorize     => false,
+
+  #--------------------------------------------------------
+	# Supported colors are...
+  #  black red green yellow blue magenta cyan white
+  #--------------------------------------------------------
+	:color_match  => 'yellow',
+	:color_desc   => 'cyan',
+	:color_footer => 'green',
+
+  #--------------------------------------------------------
+  # Web Browser command used such as 'cmdline-fu browse o'.
+  #--------------------------------------------------------
+  # for linux
+	:browse_cmd   => 'firefox',
+	# :browse_cmd   => 'google-chrome',
+	
+	# Mac OSX's default
+	# :browse_cmd   => 'open',
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cmdline-fu
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - t9md
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-29 00:00:00 +09:00
+date: 2011-01-22 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,22 +32,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 8
-        - 2
-        version: 0.8.2
-  type: :runtime
-  version_requirements: *id002
 description: "CLI frontend for http://www.commandlinefu.com/ "
 email: taqumd@gmail.com
 executables: 
@@ -65,6 +49,7 @@ files:
 - Rakefile
 - VERSION
 - bin/cmdline-fu
+- example/dot.cmdline-fu.conf
 - cmdline-fu.gemspec
 has_rdoc: true
 homepage: http://github.com/t9md/cmdline-fu