booker 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e03cf87b4d4677e8ee2cd82e676e2c37e328c53
-  data.tar.gz: 67c4a45af1cd4f92b9cf47c01e368bc0a3de5aff
+  metadata.gz: 12ce5c6cd017aa992b6dd70db7b7cf2f71731789
+  data.tar.gz: a14a6a224145a45ef3b1df81ec657560aee47f5a
 SHA512:
-  metadata.gz: e3b1ff12d26bd927a4cfbccd737f9cc9b3ede569ec955529ac5b4a729aafe2a29be87597f291765e6a9a1216f3c57a89118999d16df99cda6a98ffdab38b868e
-  data.tar.gz: cebe4d14c2d95831891035056d5e9567e4435c0e3ed70eeffdedc30ca24777b1dede6146b75ae6d1d62e11df4f8eedc7fe8cedaeff15ede44e033ad1eb5d532d
+  metadata.gz: 8855af77d02586e4ff62f1643c41b8ddcab97107e01fc22fb7c1d4bab5ec837493c3a26f0a591313d5611930457623a3ce39beab8ba4f305e8ca735b613b9998
+  data.tar.gz: 56ebded687f7e7f757e048a363e787f99fbb6454c41416e4b306ed4f8e2b49e444e1d0c9e85bbc2a97119bfeb3060852985b6f47363f5716c29f2ce0f0b5fe2c

data/bin/web

@@ -9,15 +9,4 @@ require_relative "../lib/booker"
 # also show and/or open up google chrome bookmarks
 
 
-VERSION = "0.1"
-HELP_BANNER = <<-EOS
-Open browser:
-    $ web [options]
-Options:
-    --bookmark, -b: explicity open bookmark
-      --search, -s: explicity open search
-        --complete: show completions
-EOS
-
-
 Booker.new(ARGV)

data/lib/booker.rb

@@ -1,8 +1,14 @@
-# parse command line args
+# parse web's command line args
 
 
+VERSION = "0.2"
+
+
+require 'yaml'
+require 'json'
 require_relative 'bookmarks'
-require_relative 'browser'
+require_relative 'config'
+require_relative 'consts'
 
 
 # get web opening command
@@ -12,41 +18,21 @@ class Booker
     parse args
   end
 
-  def parse(args)
-    if args.none? # no args given, show help
-      puts HELP_BANNER
-      exit 1
-    end
-
-    # doing autocompletion
-    if args[0] == "--complete"
-      args.shift # remove flag
-      allargs = args.join(' ')
-      bm = Bookmarks.new(allargs)
-      bm.autocomplete
-      exit 0
-    end
-
-
-    # doing forced bookmarking
-    if args[0] == "--bookmark" or args[0] == "-b"
-      bm = Bookmarks.new('')
-      bookmark = bm.bookmark_id(args[1])
-      url = bm.bookmark_url(bookmark)
-      puts 'opening ' + url + '...'
-      exec browse << wrap(url)
-      exit 0
-    end
+  def helper
+    pexit HELP_BANNER, 1
+  end
 
+  def pexit(msg, sig)
+    puts msg
+    exit sig
+  end
 
-    # doing forced searching
-    if args[0] == "--search" or args[0] == "-s"
-      args.shift # remove flag
-      puts 'searching ' + allargs + '...'
-      exec browse << search << allargs
-      exit 0
-    end
+  def parse(args)
+    # no args given, show help
+    helper if args.none?
 
+    # if arg starts with hyphen, parse option
+    parse_opt args if /^-.*/.match(args[0])
 
     # interpret
     while args do
@@ -66,10 +52,130 @@ class Booker
 
       else # just search for these arguments
         puts 'searching ' + allargs + '...'
+        search = BConfig.new.searcher
         exec browse << search << allargs
 
       end
     end
   end
-end
 
+  def parse_opt(args)
+    valid_opts = %w{--version -v --install -i --help -h
+    --complete -c --bookmark -b --search -s}
+
+    nextarg = args[0]
+    errormsg = "Error: ".red + "unrecognized option #{nextarg}"
+    pexit errormsg, 1 if ! (valid_opts.include? nextarg)
+
+    # doing forced bookmarking
+    if args[0] == "--bookmark" or args[0] == "-b"
+      bm = Bookmarks.new('')
+      id = args[1]
+      if id
+        url = bm.bookmark_url(id)
+        puts 'opening ' + url + '...'
+        exec browse << wrap(url)
+        exit 0
+      else
+        pexit '  Error: '.red +
+          'web --bookmark expects bookmark id', 1
+      end
+    end
+
+    # doing autocompletion
+    if args[0] == "--complete" or args[0] == "-c"
+      args.shift # remove flag
+      allargs = args.join(' ')
+      bm = Bookmarks.new(allargs)
+      bm.autocomplete
+      exit 0
+    end
+
+    # doing installation
+    if args[0] == "--install" or args[0] == "-i"
+      args.shift # remove flag
+      if args.length > 0
+        install(args)
+      else
+        pexit '  Error: '.red +
+          "web --install expects arguments: [completion, bookmarks, config]", 1
+      end
+    end
+
+    # needs some help
+    if args[0] == "--help" or args[0] == "-h"
+      helper
+    end
+
+    # doing forced searching
+    if args[0] == "--search" or args[0] == "-s"
+      args.shift # remove flag
+      allargs = args.join(' ')
+      if allargs == ""
+        pexit "--search requires an argument", 1
+      else
+        puts 'searching ' + allargs + '...'
+        search = BConfig.new.searcher
+        exec browse << search << allargs
+        exit 0
+      end
+    end
+
+    # print version information
+    if args[0] == "--version" or args[0] == "-v"
+      pexit VERSION, 0
+    end
+  end
+
+  def install(args)
+    target = args.shift
+    exit 0 if target.nil?
+
+    if /comp/i.match(target) # completion installation
+      begin
+        # determine where to install function
+        fpath = `zsh -c 'echo $fpath'`.split(' ')[0]
+        File.open(fpath + "/_web", 'w') {|f| f.write(COMPLETION) }
+        loaded = `zsh -c 'autoload -U _web'`
+        puts "Success: ".grn +
+          "installed zsh autocompletion in #{fpath}"
+      rescue
+        pexit "Failure: ".red +
+          "could not write ZSH completion _web script to $fpath", 1
+      end
+
+    elsif /bookmark/i.match(target) # bookmarks installation
+      # locate bookmarks file, show user, write to config?
+      puts 'searching for chrome bookmarks...(takes time)'
+      begin
+        bms = `find ~ -iname '*bookmarks' | grep -i chrom`.split("\n")
+        puts 'select your bookmarks file: '
+        bms.each_with_index{|bm, i| puts i.to_s.grn + " - " + bm }
+        selected = bms[gets.chomp.to_i]
+        puts 'Selected: '.yel + selected
+        BConfig.new.write('bookmarks', selected)
+        puts "Success: ".grn +
+          "config file updated with your bookmarks"
+      rescue
+        puts "Failure: ".red +
+          "could not add bookmarks to config file ~/.booker"
+      end
+
+    elsif /config/i.match(target) # default config file generation
+      begin
+        BConfig.new.write
+        puts "Success: ".grn +
+          "config file written to ~/.booker"
+      rescue
+        puts "Failure: ".red +
+          "could not write config file ~/.booker"
+      end
+
+    else # unknown argument passed into install
+      pexit "Failure: ".red +
+        "unknown installation option (#{target})", 1
+    end
+
+    install(args) # recurse til done
+  end
+end

data/lib/bookmarks.rb

@@ -1,22 +1,11 @@
-# grab bookmarks from json file on computer - this may need to be changed based
-# on operating system as well
+# grab/parse bookmarks from json file on computer
 
 
-require "rubygems"
-require "json"
-require_relative "folder"
+TERMWIDTH = 80
 
 
-# get the width of the current terminal # [columns, lines]
-#require "highline"
-#COLWIDTH = HighLine::SystemExtensions.terminal_size[0]
-
 # thx danhassin
 class String
-  def colorize(color, mod)
-    "\033[#{mod};#{color};49m#{self}\033[0;0m"
-  end
-
   def window(width)
     if self.length >= width
       self[0..width-1]
@@ -25,67 +14,73 @@ class String
     end
   end
 
+  def colorize(color, mod)
+    "\033[#{mod};#{color};49m#{self}\033[0;0m"
+  end
+
   def reset() colorize(0,0) end
-  def white() colorize(37,1) end
-  def green() colorize(32,0) end
-  def blue() colorize(34,0) end
+  def blu() colorize(34,0) end
+  def yel() colorize(33,0) end
+  def grn() colorize(32,0) end
+  def red() colorize(31,0) end
 end
 
 
 class Bookmarks
-  LOCAL_BOOKMARKS = "/Library/Application Support/Google/Chrome/Profile 1/bookmarks"
-  RAW_JSON_BOOKMARKS = JSON.parse(open(ENV['HOME'] + LOCAL_BOOKMARKS).read)
-  CHROME_BOOKMARKS = RAW_JSON_BOOKMARKS['roots']['bookmark_bar']['children']
-
+  # try to read bookmarks
   def initialize(search_term)
+    @conf = BConfig.new
+    begin
+      local_bookmarks = JSON.parse(open(@conf.bookmarks).read)
+      @chrome_bookmarks = local_bookmarks['roots']['bookmark_bar']['children']
+    rescue
+      puts "Warning: ".yel +
+        "Chrome JSON Bookmarks not found."
+      puts "Suggest: ".grn +
+        "web --install bookmarks"
+      @chrome_bookmarks = {}
+    end
+
+    # clean search term, set urls
     @searching = /#{search_term}/i
     @allurls = []
     parse
   end
 
+
   # output for zsh
   def autocomplete
-    width = 80
     @allurls.each do |url|
       # delete anything not allowed in linktitle
-      dirty_t = url.title.gsub(/[^a-z0-9\-\/_]/i, '')
-      dirty_t = url.folder + dirty_t
-      dirty_t = dirty_t.gsub(/\-+/, '-')
-      dirty_t = dirty_t.gsub(/ /,'')
-      name = dirty_t.window(width)
+      name = url.folder + url.title.gsub(/[^a-z0-9\-\/_]/i, '')
+      name.gsub!(/\-+/, '-')
+      name.gsub!(/ /,'')
+      name = name.window(TERMWIDTH)
 
       # remove strange things from any linkurls
-      dirty_u = url.url.gsub(/[,'"&?].*/, '')
-      dirty_u = dirty_u.gsub(/.*:\/+/,'')
-      dirty_u = dirty_u.gsub(/ /,'')
-      #right = [url.url.length, COLWIDTH-titlewidth].max
-      #link = dirty_u[0..right-1]
-      link = dirty_u[0..width]
+      link = url.url.gsub(/[,'"&?].*/, '')
+      link.gsub!(/.*:\/+/,'')
+      link.gsub!(/ /,'')
+      link = link[0..TERMWIDTH]
 
       # print out title and cleaned url, for autocompetion
       puts url.id + ":" + name + ":" + link
     end
   end
 
-
-  # parse a bookmark's id from tab completed form
-  def bookmark_id(url)
-    url[0..5].gsub(/[^0-9]/, '')
-  end
-
   # get link (from id number)
   def bookmark_url(id)
-    bm_url = ''
     @allurls.each do |url|
-      bm_url = url.url if id == url.id
+      if id == url.id
+        return url.url
+      end
     end
-    bm_url
   end
 
   # recursively parse gc bookmarks
   def parse(root=nil)
     # root - parent folder in ruby
-    root = Folder.new CHROME_BOOKMARKS if root.nil?
+    root = Folder.new @chrome_bookmarks if root.nil?
 
     # all current urls, to hash
     root.json.each {|x| parse_link root.title, x }
@@ -112,11 +107,25 @@ class Bookmarks
       parse(subdir)
     end
   end
+end # close bookmarks class
+
+
+# for recursively parsing bookmarks
+class Folder
+  include Enumerable
+  def initialize(title='/', json)
+    @title = title.gsub(/[: ,'"]/, '-').downcase
+    @json = json
+  end
+
+  def json() @json end
+  def title() @title end
+  def each() @json.each end
 end
 
-# just hold data
+
+# clean bookmark title, set attrs
 class Bookmark
-  # clean bookmark title, set attrs
   def initialize(f, t, u, id)
     @title = t.gsub(/[: ,'"+\-]/, '_').downcase
     @folder = f
@@ -124,19 +133,8 @@ class Bookmark
     @id = id
   end
 
-  def folder
-    @folder
-  end
-
-  def title
-    @title
-  end
-
-  def id
-    @id
-  end
-
-  def url
-    @url
-  end
+  def folder() @folder end
+  def title() @title end
+  def url() @url end
+  def id() @id end
 end

data/lib/config.rb

@@ -0,0 +1,104 @@
+# configuation - get where bookmarks are
+
+
+# detect operating system
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+    (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.linux?
+    not (OS.windows? or OS.mac?)
+  end
+end
+
+
+# return browser (chrome) opening command
+module Browser
+  extend OS
+  def browse
+    if OS.windows?
+      '/cygdrive/c/Program\ Files\ \(x86\)/Google/Chrome/Application/chrome.exe '
+    elsif OS.mac?
+      'open -a "Google Chrome" '
+    elsif OS.linux?
+      'xdg-open ' # completely guessing here
+    end
+  end
+
+  def domain
+    /.*(io|com|web|net|org|gov|edu)$/i
+  end
+
+  # helper methods
+  def prep(url)
+    if /^http/.match(url)
+      url
+    else
+      'http://' << url
+    end
+  end
+
+  def wrap(url)
+    "'" + url + "'"
+  end
+end
+
+
+# high level configuration
+class BConfig
+  YAMLCONF = ENV['HOME'] + '/.booker.yml'
+
+  def initialize
+    # config defaults (for osx, default chrome profile)
+    @config = {
+      :searcher  => "https://duckduckgo.com/?q=",
+      :bookmarks => ENV['HOME'] +
+      "/Library/Application Support/Google/Chrome/Profile 1/Bookmarks",
+    }
+
+    # configure through users yaml config file
+    @config = read(YAMLCONF)
+
+    valid = @config.keys
+    @config.each do |k,v|
+      @config[k.to_sym] = v if valid.include? k.to_sym
+    end
+  end
+
+  def read(file)
+    begin
+      @config = YAML::load(IO.read(file))
+    rescue Errno::ENOENT
+      puts "Warning: ".yel +
+        "YAML configuration file couldn't be found. Using defaults."
+      puts "Suggest: ".grn +
+        "web --install config"
+    rescue Psych::SyntaxError
+      puts "Warning: ".red +
+        "YAML configuration file contains invalid syntax. Using defaults."
+    end
+    @config
+  end
+
+  def write(k=nil, v=nil)
+    if k.nil? or v.nil?
+      File.open(YAMLCONF, 'w') {|f| f.write(@config.to_yaml) }
+    else
+      @config[k] = v
+      File.open(YAMLCONF, 'w+') {|f| f.write(@config.to_yaml) }
+    end
+  end
+
+  def bookmarks
+    @config['bookmarks']
+  end
+
+  def searcher
+    @config['searcher']
+  end
+end

data/lib/consts.rb

@@ -0,0 +1,101 @@
+# file for large constant strings
+
+
+HELP_BANNER = <<-EOS
+Open browser:
+    $ web [option] [arguments]
+
+Main options:
+    --bookmark, -b: explicity open bookmark
+     --install, -i: install [bookmarks, completion, config]
+      --search, -s: explicity search arguments
+
+Others:
+    --complete, -c: show tab completions
+     --version, -v: print version
+        --help, -h: show help
+EOS
+
+
+DEF_CONFIG = <<-EOS
+bookmarks: null
+searcher:  https://duckduckgo.com/?q=
+EOS
+
+
+COMPLETION = <<-EOS
+#compdef web
+#autoload
+
+
+_web_bookmarks() {
+    #http://zsh.sourceforge.net/Guide/zshguide06.html#l147
+    setopt glob bareglobqual nullglob rcexpandparam extendedglob automenu
+    unsetopt allexport aliases errexit octalzeroes ksharrays cshnullglob
+
+    #get chrome bookmarks
+    local -a bookmarks sites search
+
+    #grab all CLI args, remove 'web' from start
+    search=`echo $@ | sed -e '/^web /d'`
+    sites=`web --complete $search`
+    bookmarks=("${(f)${sites}}")
+
+    #terminal colors
+    BLUE=`echo -e "\033[4;34m"`
+    RESET=`echo -e "\033[0;0m"`
+
+    #parse parts, color
+    local -a ids links
+    for bookmark in ${bookmarks[@]}; do
+        local -a split
+        split=("${(@s/:/)bookmark}")
+        ids+=( $split[1] )
+        links+=("$split[2] $BLUE$split[3]$RESET")
+    done
+
+    #finally, add completions
+    compstate[insert]=menu
+    compadd -U -l -X 'found chrome bookmarks:' -d links -a ids
+}
+
+
+_web() {
+    compstate[insert]=menu
+    local curcontext state line
+    typeset -A opt_args
+    _arguments\
+        '(-b)-b[do bookmark completion]'\
+        '(--bookmark)--bookmark[do bookmark completion]'\
+        '(-c)-c[show bookmark completions]'\
+        '(--complete)--complete[show bookmark completions]'\
+        '(-i)-i[perform installations (bookmarks, completion, config)]'\
+        '(--install)--install[perform installations (bookmarks, completion, config)]'\
+        '(-s)-s[search google for...]'\
+        '(--search)--search[search google for...]'\
+        '(-h)-h[show web help]'\
+        '(--help)--help[show web help]'\
+        '(-v)-v[show version]'\
+        '(--version)--version[show version]'\
+        '*::bookmarks:->bookmarks' && return 0
+
+    _web_bookmarks $words
+}
+
+
+_web
+EOS
+
+
+ZSH_SCRIPT = <<-EOS
+# load zsh web completions
+install_loc=~/.oh-my-zsh/completions
+script=_web
+
+install:
+	mkdir -vp $(install_loc)
+	cp -v $(script) $(install_loc)/
+
+uninstall:
+	rm -v $(install_loc)/$(script)
+EOS

metadata

@@ -1,32 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: booker
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Jeremy Warner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Select your bookmarks from the command line.
-email:
-- jeremywrnr@gmail.com
+        version: 3.3.2
+description: |2
+      Select your bookmarks from the command line, by their bookmark id number.
+      ZSH users will be able to tab complete through their matches, similar to
+      how the autocompletion for `kill` works. If no bookmark is provided, web
+      will check if the argument is a website and visit it, or search duckduckgo
+      for the string argument.
+email: jeremywrnr@gmail.com
 executables:
 - web
 extensions: []
@@ -35,13 +65,16 @@ files:
 - bin/web
 - lib/booker.rb
 - lib/bookmarks.rb
-- lib/browser.rb
-- lib/folder.rb
-homepage: http://rubygems.org/gems/booker
+- lib/config.rb
+- lib/consts.rb
+homepage: http://github.com/jeremywrnr/booker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+      Thank you for installing booker!
+      To set bookmarks location, run `web --install bookmarks`
+      To add zsh completion, run `web --install completion`
 rdoc_options: []
 require_paths:
 - lib
@@ -60,5 +93,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: CLI parser for google chrome bookmarks
+summary: CLI parser/selector for google chrome bookmarks
 test_files: []

data/lib/browser.rb

@@ -1,55 +0,0 @@
-# detect operating system
-
-module OS
-  def OS.windows?
-    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
-  end
-
-  def OS.mac?
-    (/darwin/ =~ RUBY_PLATFORM) != nil
-  end
-
-  def OS.linux?
-    not (OS.windows? or OS.mac?)
-  end
-end
-
-
-# return browser (chrome) opening command
-
-module Browser
-  extend OS
-  def browse
-    if OS.windows?
-      '/cygdrive/c/Program\ Files\ \(x86\)/Google/Chrome/Application/chrome.exe '
-    elsif OS.mac?
-      'open -a "Google Chrome" '
-    elsif OS.linix?
-      'xdg-open ' # completely guessing here
-    end
-  end
-
-  def domain
-    /.*(io|com|web|net|org|gov|edu)$/i
-  end
-
-  def search
-    #"https://www.google.com/search?q="
-    #"http://www.bing.com/search?q=" #lol
-    "https://duckduckgo.com/?q="
-  end
-
-  # helper methods
-
-  def prep(url)
-    if /^http/.match(url)
-      url
-    else
-      'http://' << url
-    end
-  end
-
-  def wrap(url)
-    "'" + url + "'"
-  end
-end

data/lib/folder.rb

@@ -1,21 +0,0 @@
-# basic folder class, for parsing bookmarks
-
-class Folder
-  include Enumerable
-  def initialize(title='/', json)
-    @title = title.gsub(/[: ,'"]/, '-').downcase
-    @json = json
-  end
-
-  def title
-    @title
-  end
-
-  def json
-    @json
-  end
-
-  def each
-    @json.each
-  end
-end