glibrary 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ce83446d6daacc5d6f6091297bb24052103e5069c82a99aa5d3bf99b48abfd
-  data.tar.gz: a4f28c9a651a3bf86910810657828d850460682c602dcb37e13c1b6aee818776
+  metadata.gz: c6fe6f6ce56c501c33ad281b7d6acc4b2fc32d3a39e522a06d95044bdffb2212
+  data.tar.gz: 0106ee481b834da946078dca94cc28a3ae64705944b588005dfbe4930dadae5c
 SHA512:
-  metadata.gz: bac4fc64f4a08fbe330471f501b0000662eba38886503c324404cf2caafe5e9bb6095d16a34e719755baab43d9ef05d333c3f5c845f52898c144d0777c94acf6
-  data.tar.gz: 5293efc330c583482c989c904ab6adf70321e6f832cb10dacf2477624c38b8fb37f2a8fdb826aa28126b6531b1c84328ea4c0c15b3b4075fa692de703367cc10
+  metadata.gz: 6ddacb58256ab459b1028e76b81ce4d848a4cfefd6003f914780dd879f50fafbba025d1416dc353fe3ba8c1e4b472a4239af45bae72123723d46b0b539659383
+  data.tar.gz: 88bb81b0bf751f001f287474553fa76ff71cf3d97c7f87e129b709cf86bc5c506eb3151a15bf43537807755887d4f570912cc063faa313ebc8f8fddd2b8ebef9

data/bin/glibrary

@@ -3,51 +3,46 @@ require 'json'
 require 'io/console'
 
 require_relative '../modules/api_query'
-require_relative '../modules/command_line_parse'
-require_relative '../modules/errors'
-require_relative '../modules/error_handler'
-require_relative '../modules/exec_helper'
-require_relative '../modules/google_api_url'
-require_relative '../modules/user_prompt'
+require_relative '../exec_helpers/command_line_parse'
+require_relative '../globals/errors'
+require_relative '../exec_helpers/error_handler'
+require_relative '../exec_helpers/exec_helper'
+require_relative '../globals/google_api_url'
+require_relative '../exec_helpers/user_prompt'
 
 require_relative '../lib/book_search'
 require_relative '../lib/user_book'
 require_relative '../lib/user_library'
 
-include ExecHelper
-include UserPrompt
-include CommandLineParse
-include ErrorHandler
-
 CURRENT_DIR = File.join(File.dirname(__FILE__))
-DEFAULT_FILENAME =  File.join File.expand_path("..", CURRENT_DIR), "saved_libraries", "library.json"
 
-process_args!
+DEFAULT_FILENAME =  File.join( File.expand_path("..", CURRENT_DIR), 
+  "saved_libraries", "library.json" )
 
-@options = {}
-@filename = DEFAULT_FILENAME
-command_line_parse! #this function processes @filename and fills the @options hash.
+process_args! # processes and modifies ARGV
+filename = FileHelper.prepare(DEFAULT_FILENAME)
 
-prepare_filename_for_os!
+options = get_cli_options
+filename = options.delete(:filename) if options[:filename]
+library_mode = options.delete(:library_mode)
 
-if library_mode?
+if library_mode
 
   with_library_mode_error_handling do
-    (@library = UserLibrary.new(filename: @filename)).pretty_print
-    library_mode_user_prompt
+    user_library = UserLibrary.new(filename: filename)
+    library_mode_user_prompt(user_library)
   end
 
 else
 
   with_search_mode_error_handling do
-    @persistent_library = UserLibrary.new(filename: @filename)
-    @temp_booklist = UserLibrary.new(nonpersistent: true)
+    persistent_library = UserLibrary.new(filename: filename)
+    temp_booklist = UserLibrary.new(nonpersistent: true)
 
-    search_results = perform_search
-    search_results.selected_results.each { |info| @temp_booklist.add(UserBook.new(info)) }
-    @temp_booklist.pretty_print
+    search_results = BookSearch.new(options)
+    search_results.selected.each { |info| temp_booklist.add(UserBook.new(info)) }
 
-    search_mode_user_prompt
+    search_mode_user_prompt(temp_booklist, persistent_library)
   end
 
 end

data/exec_helpers/command_line_parse.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+
+def abort_library_mode
+  puts "Library file not found, cannot display."
+  exit
+end
+
+def print_help_message(opts)
+  puts ""
+  puts opts
+  puts "[query]: all other arguments will be treated as general search keywords"
+  puts ""
+end
+
+def get_cli_options
+  options = {}
+  OptionParser.new do |opts|
+    opts.banner = "Usage: glibrary [options...] [query]"
+
+    opts.on("-t", "--title=TITLE", "Specify a title keyword") do |t|
+      options[:title] = t
+    end
+
+    opts.on("-a", "--author=AUTHOR", "Specify an author keyword") do |a|
+      options[:author] = a
+    end
+
+    opts.on("-p", "--publisher=PUBLISHER", "Specify a publisher keyword") do |p|
+      options[:publisher] = p
+    end
+
+    opts.on("-f", "--lib-file=LIBFILE",
+            "Select a library save file. Otherwise, a default save file will be used.") do |libfile|
+      abort_library_mode if ARGV.include?("-l") && !File.exist?(libfile)
+      options[:filename] = libfile
+    end
+
+    opts.on("-l", "--library", "See your reading list; ignores all search options") do
+      return { filename: options[:filename], library_mode: true }
+    end
+
+    opts.on("-h", "--help", "Prints this help") do
+      print_help_message(opts)
+      exit
+    end
+  end.parse!
+
+ options[:search] = ARGV.join('+')
+
+ options
+end
+

data/exec_helpers/error_handler.rb

@@ -0,0 +1,35 @@
+require_relative '../globals/errors'
+
+def with_library_mode_error_handling
+  begin
+    yield
+  rescue UserQuits
+    puts "\nEnjoy your day."
+  rescue Errno::EACCES
+    puts "\nYou don't have permission to write to the file you specified.  Quitting immediately"
+    puts ""
+  end
+  exit
+end
+  
+def with_search_mode_error_handling
+  begin 
+    yield
+  rescue UserQuits
+    puts "\nThanks for browsing. Library file saved"
+    puts ""
+  rescue Errno::EACCES
+    puts "\nYou don't have permission to write to the file you specified.  Quitting immediately"
+    puts ""
+  rescue NoInternetError
+    puts "\nNo internet connection.  Please connect to the internet and try again."
+    puts ""
+  rescue SearchError 
+    puts "\nThere was an error with your query; be careful to format it well"
+    puts ""
+  rescue NoResults
+    puts "\nNo results."
+    puts ""
+  end
+  exit
+end

data/exec_helpers/exec_helper.rb

@@ -0,0 +1,4 @@
+def process_args!(args = ARGV)
+  args << '-h' if args.empty?
+  args << args.delete("-l") if args.include?("-l")
+end

data/exec_helpers/user_prompt.rb

@@ -0,0 +1,78 @@
+require_relative '../globals/errors'
+
+def verify_selection(selection, regexp)
+  raise SelectionError unless selection =~ regexp
+  raise UserQuits if selection =~ /\A[Qq]\Z/
+end
+
+def process_selection(selection)
+  return selection.to_i - 1
+end
+
+def handle_successful_prompt_completion(selected_book)
+  puts ""
+  puts "The book \"#{selected_book['title']}\" has been added to your reading list."
+end
+
+def prompt(prompt, regexp, library, suppress = nil)
+  print prompt
+  s = suppress || STDIN.gets.strip
+  verify_selection(s, regexp)
+  s = process_selection(s)
+  raise NotABook unless s <= library.size
+  return s
+end
+
+def library_mode_user_prompt(lib)
+  while true
+    begin
+      lib.pretty_print
+
+      i = prompt( "Select a book number to delete, or type \"q\" to quit: ", /\A([0-9]+|[qQ])\Z/,
+             lib)
+
+      lib.delete(i)
+      lib.save
+
+      puts "Your library now looks like this."
+      puts ""
+    rescue SelectionError
+      puts "\nSorry, your selection was invalid. Please try again."
+    rescue NotABook
+      puts "\nSorry, your selection was invalid. Make sure your selection is in the provided range."
+    end
+  end
+end
+
+
+def search_mode_user_prompt(temp_booklist, persistent_library)
+
+  temp_booklist.pretty_print
+
+  while true
+    begin
+
+      i = prompt( "Enter a number (1-5) to add a book to your reading list (or q to quit): ",
+              /\A[1-5]|[qQ]\Z/, temp_booklist )
+      selected_book = temp_booklist[i]
+
+      persistent_library << selected_book
+      persistent_library.save
+
+      handle_successful_prompt_completion(selected_book)
+      puts "Would you like to add another?"
+      puts ""
+    rescue BookDuplicateError
+      puts "\nThat book is already in your reading list.  Would you like to add another?"
+      puts ""
+    rescue SelectionError
+      puts "\nSorry, your selection was invalid.  Please try again."
+      puts ""
+    rescue NotABook
+      puts "\nSorry, your selection was invalid.  Make sure your selection is within the range of available options."
+      puts ""
+    end
+  end
+
+end
+

data/globals/errors.rb

@@ -0,0 +1,23 @@
+class SearchError < StandardError
+end
+
+class BookDuplicateError < StandardError
+end
+
+class NoInternetError < StandardError
+end
+
+class NoResults < StandardError
+end
+
+class SelectionError < StandardError
+end
+
+class NotABook < StandardError
+end
+
+class UserQuits < StandardError
+end
+
+class PersistenceError < StandardError
+end

data/lib/book_search.rb

@@ -1,14 +1,14 @@
 require 'json'
 require_relative '../modules/api_query'
-require_relative '../modules/google_api_url'
-require_relative '../modules/errors'
+require_relative '../globals/google_api_url'
+require_relative '../globals/errors'
 
 class BookSearch
   include ApiQuery
   include Enumerable
-  include Errors
+  
 
-  attr_reader :selected_results, :full_results, :url
+  attr_reader :selected, :full_results, :url
 
   def initialize(args)
     @args = args.dup
@@ -30,61 +30,61 @@ class BookSearch
     num = full_results['totalItems']
     raise NoResults unless num > 0
 
-    @selected_results = full_results['items'].first(num_results)
-    @selected_results.map! { |res| self.class.format_hash res }
+    @selected = full_results['items'].first(num_results)
+    @selected.map! { |res| self.class.format_hash res }
 
   end
 
   def each
     return to_enum :each unless block_given?
-    selected_results.each { |r| yield(r) }
+    selected.each { |r| yield(r) }
   end
 
   def [](index)
-    selected_results[index]
+    selected[index]
   end
 
   private 
-  class << self
-    def make_url_arg_list(args)
-      url = ["?q="]
+    class << self
 
-      q = args.delete('search')
-      url << q.to_s
-
-      url << args.map do |k,v|
-        k = ("in" + k) if %w[title author publisher].include?(k)
-        "%s:%s" % [k, v] 
+      def make_url(args)
+        (BASE_API_URL + make_url_arg_list(args)).gsub(/ /, "+")
       end
 
-      url.reject!(&:empty?)
-      url[0] + url[1, url.length-1].join("+")
-    end
+      def make_url_arg_list(args)
+        url = ["?q="]
+
+        q = args.delete('search')
+        url << q.to_s
 
-    def format_args(args)
-      result = args.map { |k, v| [k,v].map(&:to_s) }.to_h
-      result.reject! { |k, v| v.empty? }
-      return result.to_h
-    end
+        url << args.map do |k,v|
+          k = ("in" + k) if %w[title author publisher].include?(k)
+          "%s:%s" % [k, v] 
+        end
 
-    def searchable_arguments?(args)
-      args.keys.any? do |k| 
-        %i[search title author publisher subject isbn lccn oclc].include?(k)
+        url.reject!(&:empty?)
+        url[0] + url[1, url.length-1].join("+")
       end
-    end
 
+      def format_args(args)
+        result = args.map { |k, v| [k,v].map(&:to_s) }.to_h
+        result.reject! { |k, v| v.empty? }
+        return result.to_h
+      end
 
-    def format_hash(hash)
-      hash['volumeInfo'].merge( { 'id' => hash['id'] } )
-    end
+      def searchable_arguments?(args)
+        args.keys.any? do |k| 
+          %i[search title author publisher subject isbn lccn oclc].include?(k)
+        end
+      end
 
-    def make_url(args)
-      (BASE_API_URL + make_url_arg_list(args)).gsub(/ /, "+")
-    end
+      def format_hash(hash)
+        hash['volumeInfo'].merge( { 'id' => hash['id'] } )
+      end
 
-    def args
-      @args
-    end
+      def args
+        @args
+      end
   end
 
 end

data/lib/user_book.rb

@@ -1,8 +1,8 @@
 require 'json'
-require_relative '../modules/errors'
+require_relative '../globals/errors'
 
 class UserBook
-  include Errors
+  
 
   attr_accessor :title, :publisher, :info, :id
 

data/lib/user_library.rb

@@ -1,13 +1,12 @@
 require 'json'
-require_relative '../modules/errors'
-require_relative '../modules/exec_helper'
+require_relative '../globals/errors'
+require_relative '../modules/file_helper'
 require_relative 'user_book'
 
 
 class UserLibrary
   include Enumerable
-  include ExecHelper
-  include Errors
+  
 
   attr_reader :books, :filename
 
@@ -96,13 +95,11 @@ class UserLibrary
 
     def set_filename(name)
       @nonpersistent = false
-      @filename = name
-      prepare_filename_for_os!
+      @filename = FileHelper.prepare(name)
     end
 
     def determine_filename!
-      @filename = File.absolute_path(@filename)
-      prepare_filename_for_os!
+      @filename = FileHelper.prepare(@filename)
     end
 
     def get_raw_JSON_data

data/modules/file_helper.rb

@@ -0,0 +1,14 @@
+require_relative '../globals/errors'
+
+module FileHelper
+  def self.prepare_for_os(filename)
+    ENV.values.any? { |v| v =~ /[A-Z]:\\Windows/i } ? 
+      filename.gsub(/\//, '\\') : filename 
+  end
+
+  def self.prepare(filename)
+    filename = File.absolute_path(filename)
+    FileHelper.prepare_for_os(filename)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glibrary
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Engelbert
@@ -19,16 +19,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/glibrary
+- exec_helpers/command_line_parse.rb
+- exec_helpers/error_handler.rb
+- exec_helpers/exec_helper.rb
+- exec_helpers/user_prompt.rb
+- globals/errors.rb
+- globals/google_api_url.rb
 - lib/book_search.rb
 - lib/user_book.rb
 - lib/user_library.rb
 - modules/api_query.rb
-- modules/command_line_parse.rb
-- modules/error_handler.rb
-- modules/errors.rb
-- modules/exec_helper.rb
-- modules/google_api_url.rb
-- modules/user_prompt.rb
+- modules/file_helper.rb
 - saved_libraries/.gitkeep
 homepage: https://github.com/pmengelbert/g_library
 licenses:
@@ -38,6 +39,8 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - modules
+- exec_helpers
+- globals
 - saved_libraries
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/modules/command_line_parse.rb

@@ -1,55 +0,0 @@
-require_relative 'errors'
-
-module CommandLineParse
-  require 'optparse'
-  include Errors
-
-  def handle_nonexistent_file
-    (puts "Library file not found, cannot display."; exit)
-    puts "Creating new file"
-  end
-
-  def print_help_message(opts)
-    puts ""
-    puts opts
-    puts "[query]: all other arguments will be treated as general search keywords"
-    puts ""
-  end
-
-  def command_line_parse!
-    OptionParser.new do |opts|
-      opts.banner = "Usage: glibrary [options...] [query]"
-
-      opts.on("-t", "--title=TITLE", "Specify a title keyword") do |t|
-        @options[:title] = t
-      end
-
-      opts.on("-a", "--author=AUTHOR", "Specify an author keyword") do |a|
-        @options[:author] = a
-      end
-
-      opts.on("-p", "--publisher=PUBLISHER", "Specify a publisher keyword") do |p|
-        @options[:publisher] = p
-      end
-
-      opts.on("-f", "--lib-file=LIBFILE",
-              "Select a library save file. Otherwise, a default save file will be used.") do |libfile|
-        @filename = File.absolute_path(libfile)
-        handle_nonexistent_file if ARGV.include?("-l") && !File.exist?(@filename)
-      end
-
-      opts.on("-l", "--library", "See your reading list; ignores all search options") do
-        @options = nil
-        return
-      end
-
-      opts.on("-h", "--help", "Prints this help") do
-        print_help_message(opts)
-        exit
-      end
-    end.parse!
-
-   @options[:search] = ARGV.join('+')
-    
-  end
-end

data/modules/error_handler.rb

@@ -1,38 +0,0 @@
-require_relative 'errors'
-
-module ErrorHandler
-  def with_library_mode_error_handling
-    begin
-      yield
-    rescue UserQuits
-      puts "\nEnjoy your day."
-    rescue Errno::EACCES
-      puts "\nYou don't have permission to write to the file you specified.  Quitting immediately"
-      puts ""
-    end
-    exit
-  end
-    
-  def with_search_mode_error_handling
-    begin 
-      yield
-    rescue UserQuits
-      puts "\nThanks for browsing. Library file saved"
-      puts ""
-    rescue Errno::EACCES
-      puts "\nYou don't have permission to write to the file you specified.  Quitting immediately"
-      puts ""
-    rescue NoInternetError
-      puts "\nNo internet connection.  Please connect to the internet and try again."
-      puts ""
-    rescue SearchError 
-      puts "\nThere was an error with your query; be careful to format it well"
-      puts ""
-    rescue NoResults
-      puts "\nNo results."
-      puts ""
-    end
-    exit
-  end
-
-end

data/modules/errors.rb

@@ -1,25 +0,0 @@
-module Errors
-  class SearchError < StandardError
-  end
-
-  class BookDuplicateError < StandardError
-  end
-
-  class NoInternetError < StandardError
-  end
-
-  class NoResults < StandardError
-  end
-
-  class SelectionError < StandardError
-  end
-
-  class NotABook < StandardError
-  end
-
-  class UserQuits < StandardError
-  end
-
-  class PersistenceError < StandardError
-  end
-end

data/modules/exec_helper.rb

@@ -1,24 +0,0 @@
-require_relative 'errors'
-
-module ExecHelper
-  include Errors
-
-  def process_args!(args = ARGV)
-    args << '-h' if args.empty?
-    args << args.delete("-l") if args.include?("-l")
-  end
-
-  def library_mode?
-    @options.nil?
-  end
-
-  def prepare_filename_for_os!
-    @filename.gsub!(/\//, '\\') if ENV.values.any? { |v| v =~ /[A-Z]:\\Windows/i }
-  end
-
-  def perform_search
-    search = @options[:search] || ARGV.join('+')
-    s = BookSearch.new(search: search, title: @options[:title], author: @options[:author], 
-                       publisher: @options[:publisher])
-  end
-end

data/modules/user_prompt.rb

@@ -1,75 +0,0 @@
-require_relative 'errors'
-
-module UserPrompt
-  include Errors
-
-  def verify_selection(selection, regexp)
-    raise SelectionError unless selection =~ regexp
-    raise UserQuits if selection =~ /\A[Qq]\Z/
-  end
-
-  def process_selection(selection)
-    return selection.to_i - 1
-  end
-
-  def handle_successful_prompt_completion(selected_book)
-    puts ""
-    puts "The book \"#{selected_book['title']}\" has been added to your reading list."
-  end
-
-  def prompt(prompt, regexp, library, suppress = nil)
-    print prompt
-    s = suppress || STDIN.gets.strip
-    verify_selection(s, regexp)
-    s = process_selection(s)
-    raise NotABook unless s <= library.size
-    return s
-  end
-
-  def library_mode_user_prompt
-    while true
-      begin
-        i = prompt( "Select a book number to delete, or type \"q\" to quit: ", /\A([0-9]+|[qQ])\Z/,
-               @library )
-
-        @library.delete(i)
-        @library.save
-        @library.pretty_print
-
-        puts "Your library now looks like this."
-        puts ""
-      rescue SelectionError
-        puts "\nSorry, your selection was invalid. Please try again."
-      rescue NotABook
-        puts "\nSorry, your selection was invalid. Make sure your selection is in the provided range."
-      end
-    end
-  end
-
-
-  def search_mode_user_prompt
-    while true
-      begin
-        i = prompt( "Enter a number (1-5) to add a book to your reading list (or q to quit): ",
-                /\A[1-5]|[qQ]\Z/, @temp_booklist )
-        selected_book = @temp_booklist[i]
-
-        @persistent_library << selected_book
-        @persistent_library.save
-
-        handle_successful_prompt_completion(selected_book)
-        puts "Would you like to add another?"
-        puts ""
-      rescue BookDuplicateError
-        puts "\nThat book is already in your reading list.  Would you like to add another?"
-        puts ""
-      rescue SelectionError
-        puts "\nSorry, your selection was invalid.  Please try again."
-        puts ""
-      rescue NotABook
-        puts "\nSorry, your selection was invalid.  Make sure your selection is within the range of available options."
-        puts ""
-      end
-    end
-  end
-end