bropages 0.0.4 → 0.0.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDc4Yjc0ZmMzODY4YmJiNjhlZDFiMzYwNGIwZmRjNmFhMWQ4MmMwMQ==
-  data.tar.gz: !binary |-
-    NDRlNTJkNGI0ZmQ2ZjJkOTkxNWIzMWE2MjQyNTYyOGRiNzE1NmIyYw==
+SHA1:
+  metadata.gz: 72eaf532302a8ec6bf8a50eb76b9b3d4368374cb
+  data.tar.gz: 93fc8a746da87159d17b20638ebba107ed2974bd
 SHA512:
-  metadata.gz: !binary |-
-    ZDU5NDYwMTY5Mjc2NDkwODExMTk1MmVmOTdiNzcwOTg4MzVhMDM4ZDc4Y2Q4
-    NDAyYTNlNDMzYjZjMGRiNDc0YThiNjg2ZTU4ZGE0NTg2OTUwOWY1NmZjZDE1
-    ZWI4NjQ0NjE4NTc4ODljOWRjMDQ5YWZiYzhkMzIyZTY0YjZjZDY=
-  data.tar.gz: !binary |-
-    NjA4MzQ3YWNiMTNiZGEyNmMwNjA0YTgwMzc3NmU4YjA3Y2JiZGQzNTgxYjM5
-    MTM5NDc0ZWM3NjI0OGFmOTZiOWE5YjJmNWRhYzYyOGY2ZmUxNThmY2Q1ODFk
-    YmU0ZTE4NjAxNzVhYjQ2ODEyZGRkZmM0OTYyZGNhN2UxZWQ4MDg=
+  metadata.gz: 031642ebd06e5a47a0b760bdab559c19cfeb617abf5467ae5f37e1eb4be9ca4715c0ee87809f79ce7e95571a39c8ec91bc064848b9ec11c012afab4af1e9b31d
+  data.tar.gz: cb0aa08173c7dbd0710027d2dea4f7246a4f94a6dd1b3106e9c39a95e67fe9628c48aa21256b69239635e5f8c97fbf83b7fa2cd05b93d149e818a9f99ed20c66

data/lib/bro/bro_state.rb

@@ -0,0 +1,66 @@
+module Bro
+  class BroState < State
+    def get_arg_or_last_command args
+      cmd = args.first
+      if args.empty?
+        state = read_state
+        cmd = state[:cmd]
+      end
+      cmd
+    end
+
+    def check_email
+      begin
+        is_invalid_code read_state[:code], read_state[:email]
+      rescue => e
+        puts e
+        prompt_email
+      end
+      {code: read_state[:code], email: read_state[:email]}
+    end
+
+    def prompt_email
+      say "Bropages.org requires an email address verification to do this action".colored.yellow
+      say "Your email address and verification code will be saved locally on your machine to a file called #{"~/.bro".colored.yellow} and used for future bropages.org activity"
+      say "When you enter your email, you'll get a verification email with a code. Enter the code when prompted"
+      
+      email = ""
+
+      while is_invalid_email email
+        email = ask "What's your email address?".colored.green
+      end
+
+      begin
+        res = RestClient.post URL + '/users.json', { user: { email: email }, format: 'json', multipart: true }
+      rescue => e
+        say "There was an error delivering to your email address. Please try again later".colored.yellow.on_red
+        raise e
+      else
+        say "Great! We're sending an email to #{email}. Enter the verification code below and you'll be all set from now on."
+
+        invalid_code = true
+        begin
+          code = ask "Please enter the verification code: "
+          begin
+            is_invalid_code code, email
+            invalid_code = false
+            say "Great! You're verified! FYI, your email and code are stored locally in ~/.bro"
+            write_state({ email: email, code: code })
+          rescue => e
+            say "Woops, there was a problem verifying your email. Please try again".colored.yellow.on_red
+          end
+        end while invalid_code
+      end
+      
+    end
+
+    def is_invalid_code code, email
+      res = RestClient.get URL + "/users/verify?code=#{code}&email=#{email}"
+    end
+
+    def is_invalid_email email
+      regex = /^[a-zA-Z0-9_.+\-]+@[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-.]+$/
+      email.scan(regex).empty?
+    end
+  end
+end

data/lib/bro/state.rb

@@ -0,0 +1,45 @@
+module Bro
+  class State
+
+    def initialize options
+      @file = options[:file]
+    end
+
+    # write state to this file, using the existing key/vals as defaults
+    # format is key=val;key2=val;key3=val
+    def write_state obj, override=false
+      # read the ~/.bro file and load the settings as defaults
+      # we don't want to lose data if we're not writing over it all
+      read_state.each {|k,v|
+        obj[k] = v if obj[k].nil?
+      } unless override # unless we pass in strict parsing
+
+      # actually serialize the data and write the file
+      File.open(@file, 'w') do |file|
+        data_pairs = obj.collect{ |k,v| "#{k}=#{v}" }
+        file.write data_pairs.join(";") + "\n"
+      end
+    end
+
+    def reset_lookup_ids
+      # drop all lookup ids
+      write_state read_state().keep_if { |x| !!!(x =~ /\d+/) }, true
+    end
+
+    # read the ~/.bro file and return a hash of the values
+    def read_state
+      obj = {}
+      begin
+        contents = File.read @file
+        contents.strip.split(";").each {|kv|
+          chunk = kv.split("=")
+          key = chunk[0].intern
+          obj[key] = chunk[1]
+        }
+      rescue => e
+        # ignore file not found
+      end
+      obj
+    end
+  end
+end

data/lib/bro/string_hacks.rb

@@ -0,0 +1,25 @@
+class String
+  def unindent 
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+  end
+
+  def status
+    self.colored.yellow
+  end
+
+  def success
+    self.colored.green.bold
+  end
+
+  def problem
+    self.colored.yellow_on_red_bold
+  end
+
+  def sorry
+    self.colored.red.bold
+  end
+
+  def important
+    self.colored.magenta
+  end
+end

data/lib/bro.rb

@@ -6,15 +6,22 @@ require 'highline'
 require 'smart_colored'
 require 'rest-client'
 
+$LOAD_PATH << "."
+require_relative 'bro/state.rb'
+require_relative 'bro/bro_state.rb'
+require_relative 'bro/string_hacks.rb'
+include Bro
+
 URL = ENV["BROPAGES_URL"] || 'http://bropages.org'
 FILE = ENV["HOME"] + '/.bro'
 
 program :name, 'bro'
-program :version, '0.0.4'
+program :version, '0.0.6'
 program :description, "Highly readable supplement to man pages.\n\nShows simple, concise examples for commands."
- 
 default_command :lookup
 
+state = Bro::BroState.new({:file => FILE})
+
 command :thanks do |c|
   c.syntax = 'bro thanks [COMMAND]'
   c.summary = 'Upvote an entry, bro'
@@ -22,15 +29,16 @@ command :thanks do |c|
   c.example 'Upvote the bro entry for curl', 'bro thanks curl'
   c.action do |args, options|
     begin
-      login_details = check_email
-    rescue
-      say "Sorry, you can't do this without email verification".colored.red
+      login_details = state.check_email
+    rescue => e
+      say "Sorry, you can't do this without email verification".sorry
+      say "#{e}"
     end
     unless login_details.nil?
-      cmd = read_state[:cmd]
+      cmd = state.read_state[:cmd]
 
       if cmd.nil?
-        say "\nYou must first look up a command before downvoting. For example: bro curl\n\n"
+        say "\nYou must first look up a command before downvoting. For example: bro curl\n\n".sorry
         return
       end
 
@@ -38,43 +46,45 @@ command :thanks do |c|
       if idkey.nil?
         idkey = "1"
       end
-      id = read_state[idkey.intern]
+      id = state.read_state[idkey.intern]
 
       if id.nil?
-        say "\nThat id (#{idkey}) does not exist for #{cmd}, try another one"
-        return
+        say "That id (#{idkey}) does not exist for #{cmd}, try another one".sorry
       end
 
-      begin
-        res = RestClient.get URL + "/thanks/#{id}", { params: login_details }
-      rescue => e
-        say e.message
-        say "There was a problem thanking the #{cmd} entry. This entry may not exist or bropages.org may be down".colored.yellow.on_red
-      else
-        say "You just gave thanks to an entry for #{cmd}! You rock!"
-        say res
+      unless id.nil?
+        begin
+          res = RestClient.get URL + "/thanks/#{id}", { params: login_details }
+        rescue => e
+          say e.message
+          say "There was a problem thanking the #{cmd} entry. This entry may not exist or bropages.org may be down".problem
+        else
+          say "You just gave thanks to an entry for #{cmd}!".status
+          say "You rock!".success
+        end
       end
     end
   end
 end
 
-command :no do |c|
-  c.syntax = 'bro no [ID]'
+noblock = lambda { |c|
+  c.syntax = 'bro ...no [ID]'
   c.summary = 'Downvote an entry, bro'
   c.description = 'Downvote a bro entry for the last command you looked up. If called without ID, it will downvote the top entry of the last command you looked up.'
-  c.example 'Downvote the bro entry for curl', "bro curl\n\nbro no"
+  c.example 'Downvote the bro entry for curl', "bro curl\n\nbro ...no"
   c.action do |args, options|
     begin
-      login_details = check_email
+      login_details = state.check_email
     rescue
-      say "Sorry, you can't do this without email verification".colored.red
+      say "Sorry, you can't do this without email verification".sorry
+      say "#{e}"
     end
     unless login_details.nil?
 
-      cmd = read_state[:cmd]
+      cmd = state.read_state[:cmd]
 
       if cmd.nil?
-        say "\nYou must first look up a command before downvoting. For example: bro curl\n\n"
+        say "\nYou must first look up a command before downvoting. For example: bro curl\n\n".sorry
         return
       end
 
@@ -82,52 +92,73 @@ command :no do |c|
       if idkey.nil?
         idkey = "1"
       end
-      id = read_state[idkey.intern]
+      id = state.read_state[idkey.intern]
 
       if id.nil?
-        say "\nThat id (#{idkey}) does not exist for #{cmd}, try another one"
-        return
+        say "That id (#{idkey}) does not exist for #{cmd}, try another one".sorry
       end
 
-      begin
-        res = RestClient.get URL + "/no/#{id}", { params: login_details }
-      rescue => e
-        say e.message
-        say "There was a problem downvoting the #{cmd} entry. This entry may not exist or bropages.org may be down".colored.yellow.on_red
-      else
-        say "You just downvoted an entry for #{cmd}"
-        say res
+      unless id.nil?
+        begin
+          res = RestClient.get URL + "/no/#{id}", { params: login_details }
+        rescue => e
+          say "There was a problem downvoting the #{cmd} entry. This entry may not exist or bropages.org may be down".problem
+          say e
+        else
+          say "You just downvoted an entry for #{cmd}".status
+          say "You rock!".success
+        end
       end
     end
   end
-end
+}
+
+command :"...no", &noblock
+command :no, &noblock
 
 command :add do |c|
   c.syntax = 'bro add [COMMAND] [-m MESSAGE]'
   c.summary = 'Add an entry, bro'
-  c.description = "This adds an entry to the http://bropages.org database.\n\nCalled without parameters will add an entry for the last thing you looked up with bro."
+  c.description = <<-QQQ.unindent
+  This adds an entry to the http://bropages.org database.
+
+  Called without parameters will add an entry for the last thing you looked up with bro.
+  QQQ
   c.example 'Launch your editor to add an entry for curl', 'bro add curl'
   c.example 'Quickly add an entry for curl', 'bro add curl -m "curl http://google.com"'
-  #TODO c.option '-m', 'An optional inline entry. This won\'t trigger a system editor to open'
+  # TODO c.option '-m', 'An optional inline entry. This won\'t trigger a system editor to open'
   c.action do |args, options|
     begin
-      login_details = check_email
+      login_details = state.check_email
     rescue
-      say "Sorry, you can't do this without email verification".colored.red
+      say "Sorry, you can't do this without email verification".sorry
+      say e
     end
 
     unless login_details.nil?
 
-      cmd = get_arg_or_last_command args
+      cmd = state.get_arg_or_last_command args
 
       if cmd.nil?
         say "\nYou must enter a COMMAND after 'bro add'. For example: bro add curl\n\n"
       else
-        prompt = "#~ Bro entry for command '#{cmd}'\n#~ Just provide a few, simple, common case examples for how to use this command\n#~ Comments starting with #~ are removed\n"
+        prompt = <<-QQQ.unindent
+          #~ Bro entry for command '#{cmd}'
+          #~ Provide a useful example for how to use '#{cmd}'
+          #~ Comments starting with #~ are removed
+          #~
+          #~ Example for command 'man':
+          #~ # Opens up the manual page for the command 'ls'
+          #~ man ls
+          #~
+          
+          # ex
+          cmd
+          QQQ
         entry = ask_editor prompt, "vim"
         if entry.gsub(prompt, '').strip.length > 0
           if agree "Submit this entry for #{cmd}? [Yn] "
-            say "All right, sending your entry..."
+            say "All right, sending your entry...".status
             begin
               res = RestClient.post URL + '/', login_details.merge({ entry: { cmd: cmd, msg: entry}, format: 'json', multipart: true })
             rescue => e
@@ -145,13 +176,13 @@ command :add do |c|
               File.open(file, 'w') do |f|
                 f.write entry
               end
-              say "Woops. There was an error! Your entry was saved to #{file}".colored.yellow.on_red
+              say "Woops. There was an error! Your entry was saved to #{file}".problem
             else
-              say "Successfully submitted.".colored.green
+              say "Successfully submitted.".success
             end
           end
         else
-          say "Canceled. Did not submit entry for '#{cmd}'".colored.yellow.on_red
+          say "Canceled. Did not submit entry for '#{cmd}'".status
         end
       end
     end
@@ -165,19 +196,35 @@ command :lookup do |c|
   c.example 'Look up the bro entries for curl', 'bro curl'
   c.action do |args, options|
     if args.empty?
-      say "\n#{"Bro! Specify a command first!".colored.red}\n\nFor example, try #{"bro curl".colored.green}\n\nUse #{"bro help".colored.yellow} for more info\n\n"
+      say <<-QQQ.unindent
+      #{"Bro! Specify a command first!".colored.red}
+      
+      \t* For example try #{"bro curl".colored.green}
+      
+      \t* Use #{"bro help".colored.yellow} for more info
+      
+      QQQ
     else
       cmd = args.first
 
+      state.reset_lookup_ids()
+
       # write to ~/.bro file with last command
-      write_state({ cmd: cmd })
+      state.write_state({ cmd: cmd })
 
       # connect to webservice for entry
       error = false
       begin
         res = RestClient.get URL + '/' + cmd + '.json'
       rescue => e
-        say "\nThe #{cmd.colored.yellow} command isn't in our database\n\n\t* Use #{"bro add".colored.green.underline} to add #{cmd.colored.yellow} to our database!\n\n\t* Need help? Visit #{"http://bropages.org/help".colored.underline}\n\n"
+        say <<-QQQ.unindent
+        The #{cmd.colored.yellow} command isn't in our database
+        
+        \t* Use #{"bro add".colored.green.underline} to add #{cmd.colored.yellow} to our database!
+        
+        \t* Need help? Visit #{"http://bropages.org/help".colored.underline}
+        
+        QQQ
         error = true
       end
 
@@ -185,7 +232,7 @@ command :lookup do |c|
         enable_paging
         list = JSON.parse res
         s = list.length == 1 ? 'y' : 'ies'
-        say "#{list.length} entr#{s} for #{cmd}\n".colored.yellow.bold.underline
+        say "#{list.length} entr#{s} for #{cmd}\n".status.underline
 
         sep = ""
         (HighLine::SystemExtensions.terminal_size[0] - 5).times { sep += "." }
@@ -198,13 +245,13 @@ command :lookup do |c|
 
             obj = {}
             obj["#{i}"] = data['id']
-            write_state(obj)
+            state.write_state(obj)
 
             days = (DateTime.now - DateTime.parse(data['updated_at'])).ceil.to_i
 
             body = data['msg']
 
-            body = body.gsub(/^([^#][^\n]*)$/, "\\1".colored.magenta)
+            body = body.gsub(/^([^#][^\n]*)$/, "\\1".important)
 
             say sep + "\n\n" if i > 1
 
@@ -212,11 +259,10 @@ command :lookup do |c|
 
             upstr = "bro thanks"
             upstr += " #{i}" unless isDefault
-            downstr = "bro no"
+            downstr = "bro ...no"
             downstr += " #{i}" unless isDefault
-            downstr += "\t" if isDefault
 
-            msg = "\t#{upstr.colored.green}\tto upvote (#{data['up']})\n\t#{downstr.colored.red}\tto downvote (#{data['down']})\n"
+            msg = "\t#{upstr.colored.green}\tto upvote (#{data['up']})\n\t#{downstr.colored.red}\tto downvote (#{data['down']})"
             if days > 0
               #msg += "\tlast updated\t#{days} days ago"
             end
@@ -227,97 +273,3 @@ command :lookup do |c|
     end
   end
 end
-
-def get_arg_or_last_command args
-  cmd = args.first
-  if args.empty?
-    state = read_state
-    cmd = state[:cmd]
-  end
-  cmd
-end
-
-def check_email
-  begin
-    is_invalid_code read_state[:code], read_state[:email]
-  rescue => e
-    prompt_email
-  end
-  {code: read_state[:code], email: read_state[:email]}
-end
-
-def prompt_email
-  say "Bropages.org requires an email address verification to do this action".colored.yellow
-  say "Your email address and verification code will be saved locally on your machine to a file called #{"~/.bro".colored.yellow} and used for future bropages.org activity"
-  say "When you enter your email, you'll get a verification email with a code. Enter the code when prompted"
-  
-  email = ""
-
-  while is_invalid_email email
-    email = ask "What's your email address?".colored.green
-  end
-
-  begin
-    res = RestClient.post URL + '/users.json', { user: { email: email }, format: 'json', multipart: true }
-  rescue => e
-    say "There was an error delivering to your email address. Please try again later".colored.yellow.on_red
-    raise e
-  else
-    say "Great! We're sending an email to #{email}. Enter the verification code below and you'll be all set from now on."
-
-    invalid_code = true
-    begin
-      code = ask "Please enter the verification code: "
-      begin
-        is_invalid_code code, email
-        invalid_code = false
-        say "Great! You're verified! FYI, your email and code are stored locally in ~/.bro"
-        write_state({ email: email, code: code })
-      rescue => e
-        say "Woops, there was a problem verifying your email. Please try again".colored.yellow.on_red
-      end
-    end while invalid_code
-  end
-  
-end
-
-def is_invalid_code code, email
-  res = RestClient.get URL + "/users/verify?code=#{code}&email=#{email}"
-end
-
-def is_invalid_email email
-  regex = /^[a-zA-Z0-9_.+\-]+@[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-.]+$/
-  email.scan(regex).empty?
-end
-
-# write state to this file, using the existing key/vals as defaults
-# format is key=val;key2=val;key3=val
-def write_state obj
-  # read the ~/.bro file and load the settings as defaults
-  # we don't want to lose data if we're not writing over it all
-  read_state.each {|k,v|
-    obj[k] = v if obj[k].nil?
-  }
-
-  # actually serialize the data and write the file
-  File.open(FILE, 'w') do |file|
-    data_pairs = obj.collect{ |k,v| "#{k}=#{v}" }
-    file.write data_pairs.join(";") + "\n"
-  end
-end
-
-# read the ~/.bro file and return a hash of the values
-def read_state
-  obj = {}
-  begin
-    contents = File.read FILE
-    contents.strip.split(";").each {|kv|
-      chunk = kv.split("=")
-      key = chunk[0].intern
-      obj[key] = chunk[1]
-    }
-  rescue => e
-    # ignore file not found
-  end
-  obj
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bropages
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - bropages.org
@@ -11,73 +11,73 @@ cert_chain: []
 date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: smart_colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Highly readable supplement to man pages. Shows simple, concise examples
@@ -90,6 +90,9 @@ extra_rdoc_files: []
 files:
 - bin/bro
 - lib/bro.rb
+- lib/bro/bro_state.rb
+- lib/bro/state.rb
+- lib/bro/string_hacks.rb
 homepage: http://bropages.org
 licenses: []
 metadata: {}
@@ -99,12 +102,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []