scholar-rename 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 397978ea892a1945fb1d9736227e68ded227e9bef3e45df49fd159681bf6b616
-  data.tar.gz: bbc246ab4d4d2435a39ba016f1d9e1a0bf38568e166b63f4b15ef36ef72f00d6
+  metadata.gz: 18d3a5bccb17ac4d45228e58e689124428493e4ccba7f83b1690c540a6919af3
+  data.tar.gz: 7ebe641484f488f50ae01dbe5358dcc3e2f8988fc9a15d877482d5330d2915cd
 SHA512:
-  metadata.gz: bf18f43015aac9640cf69c33d5753e8eeb10c4ac92b6005e624e63ae0b216783741493ffcc889f27090bfe8efc7f1c044310cd51fd31735a17e094988656d177
-  data.tar.gz: 56bfb5522f243da2ebe3ef4a1146ef5b1f7f45ee78d81b9ae09360a4347a7dc699c59d8ed148bb3142eace2e9bc0b926335d8a668a65c07a477b7b3b5f5f9ac3
+  metadata.gz: 80157449b67dad30f1df46217afbc2919f5ea9d8bd76e689d4fd2ba5dffff4c8dee0b1aeb9fb48a74e1874dd13302514a1891805724e463d513136947b356103
+  data.tar.gz: 4345f98dbf5b26f94922aa690280ebc22492882b4b42eece595cc1ca0194e466fe9104417247069701a466cdf25f740227d25309dd258cfdee257672d635fcb4

data/bin/scholar-rename

@@ -7,7 +7,7 @@
 # renames a pdf file to author-title-year.pdf
 # or other formats based on your selection
 
-require_relative '../lib/selector'
-require_relative '../lib/renamer'
+require_relative "../lib/selector"
+require_relative "../lib/renamer"
 
 r = Renamer.new ARGV

data/lib/renamer.rb

@@ -1,47 +1,61 @@
 require_relative "./version.rb"
 
 class Renamer
-  @@TESTING = false
+  attr_reader :version, :formats, :selector, :format
 
-  attr_reader :vers, :formats, :selector, :format
   def initialize(*args)
     args = args.flatten
     a0 = args.first
-    #puts args.inspect
+    al = args.last
 
-    @opts = {}
-    @vers = SR::Version
+    @real_file = false
+    @options = { :format => 0, :auto => false, :debug => false, :test => false }
+    @version = SR::Version
     @selector = Selector.new
     @formats = @selector.gen_forms("Year", "Title", "Author")
 
-    if !args.last.nil? && args.last[0] != "-"
-      @file = File.join(Dir.pwd, args.last).to_s
+    if args.include? "--debug"
+      @options[:debug] = true
+    end
+
+    if args.include? "--test"
+      @options[:test] = true
+      def puts(*x) x; end
     end
 
-    if @file && !File.file?(@file)
+    # Filename comes last.
+    if !al.nil? && al[0] != "-"
+      @file = File.join(Dir.pwd, args.last).to_s
+      @real_file = @file && File.file?(@file)
+    end
+    if @file && !@real_file
       puts "Input #{@file} not found."
+      puts "Please specify a pdf file to use with scholar-rename."
       exit 1
     end
 
-    if args.length == 0
-      puts "usage: scholar-rename (--format #) [file.pdf]"
+    # Main argument processing.
+    if args.length == 0 || a0 == "--h" || a0 == "--help"
+      puts "usage: scholar-rename (--format #) (--auto) [file.pdf]"
+      puts "\t--show-formats\tshow format options"
+      puts "\t--auto\tpick default formatter"
       puts "\t-v, --version\tshow version number"
-      puts "\t--format\tshow format options"
     elsif a0 == "-v" || a0 == "--version"
-      puts @vers
-    elsif a0 == "--format" && args.length == 1
-      @formats.each_with_index {|x, i| puts "\t#{i}: #{x}"}
+      puts @version
+      exit 0 unless @options[:test]
     elsif !has_prereq?
       puts "please install pdftotext (via poppler) to use scholar-rename"
-      puts "brew install pkg-config poppler"
+      puts "OSX: brew install pkg-config poppler"
       exit 1
-    elsif a0 == "--format" && args.length > 1
-      @format = args[1].to_s
+    elsif a0 == "--show-formats"
+      @formats.each_with_index { |x, i| puts "\t#{i}: #{x}" }
+    elsif a0 == "--format"
+      @options[:format] = args[1].to_i
+    elsif a0 == "--auto"
+      @options[:auto] = true
     end
 
-    if @file && File.file?(@file)
-      rename
-    end
+    rename args if @real_file
   end
 
   def has_prereq?
@@ -49,22 +63,20 @@ class Renamer
     $?.success?
   end
 
-  def rename
+  def rename(args)
     raw = `pdftotext -q '#{@file}' -` # may contain non-ascii characters
-    content = raw.encode('UTF-8', :invalid => :replace, :undef => :replace)
-
-    # for debugging
-    #now = Time.now.to_i.to_s # current time, unique temp file
-    #temp = File.join(Dir.pwd, "temp-scholar-rename-text-#{now}")
-    #system("pdftotext -q '#{@file}' '#{temp}'")
-
+    content = raw.encode("UTF-8", :invalid => :replace, :undef => :replace)
+    
     # Choose pdf qualities
     @selector.set_content(content)
-    @selector.options = {:format => @format.to_i} if @format
-    @selector.select_all # choose props
+    @selector.options = @options
+    @selector.select_all
+    md = @selector.metadata
 
-    if @@TESTING
-      puts @file, @selector.title
+    if @options[:debug]
+      puts md[:year] if args.include? "--show-year"
+      puts md[:title] if args.include? "--show-title"
+      puts md[:author] if args.include? "--show-author"
     else
       File.rename(@file, @selector.title)
       puts "Saved #{@selector.title}"

data/lib/selector.rb

@@ -2,106 +2,102 @@
 # I wonder if this could be augmented with information from google scholar
 # somehow, there is probably a ruby (or at least python) api.
 
-require 'colored'
-
-class String
-  alias_method :bow, :black_on_white
-end
-
 class Selector
-  attr_reader :title
-  attr_accessor :content, :options
+  attr_reader :title, :metadata, :content
+  attr_accessor :options
 
-  # https://stackoverflow.com/questions/9503554/
-  def initialize(c = '', opts = {:format => 0})
+  def initialize(c = "Test\nPDF\nContent", opts = { :format => 0, :auto => true })
     set_content(c)
-    @fulltxt = c.split("\n")
     @options = opts
+    if opts[:test]
+      def puts(*x) x; end
+    end
   end
 
   def set_content(str)
-    @content = str.split("\n")[0..14]
-      .reject {|x| x.length < 2 }
-      .map {|x| x[0..100] } # trim
+    @full_text = str.split("\n")
+    @content = @full_text[0..14]
+      .reject { |x| x.length < 2 }
+      .map { |x| x[0..100] } # trim
   end
 
   def select_all
-    puts "Options:".bow
-    @content.each_with_index {|l, i| puts "#{i}\t#{l}" }
-    printf "Select title line number ".bow
+    if !@options[:auto]
+      puts "Options:"
+      @content.each_with_index { |l, i| puts "#{i}\t#{l}" }
+    end
+    printf "Select title line number " unless @options[:auto]
     title = choose(@content, print: false)
 
-    printf "Select author line number ".bow
+    printf "Select author line number " unless @options[:auto]
     authors = choose(@content, print: false)
 
-    puts "Select author form:".bow
+    puts "Select author form:" unless @options[:auto]
     author = gen_authors(authors)
 
-    year = gen_year # just read it
-
+    # Automatically match.
+    year = gen_year
+    
     forms = gen_forms(year, title, author)
+    @metadata = {:year => year, :title => title, :author => author}
     @title = forms[@options[:format]]
-
-    #puts "Select desired title:".bow
-    #@title = choose(forms)
   end
 
   # based on the collected information, generate different forms of the title.
-  # perhaps at some point this could be autoselected from the command line,
-  # like how the date formatting works, using symbols for different features...
-  # in theory could also handle this with the eval method like above - but this
-  # would probably be better as a send call or an instance_eval method :/
   def gen_forms(y, t, a)
     ad = a.downcase
     au = a.upcase
     return [
-      "#{y} - #{a} - #{t}.pdf",
-      "#{y} #{a} #{t}.pdf",
-      "#{a}_#{y}_#{t}.pdf".gsub(" ", "_"),
-      "#{au}_#{y}_#{t}.pdf".gsub(" ", "_"),
-      "#{ad}_#{y}_#{t}.pdf".gsub(" ", "_"),
-      "#{a} #{y} #{t}.pdf",
-      "#{au} #{y} #{t}.pdf",
-      "#{ad} #{y} #{t}.pdf",
-    ]
+             "#{y} - #{a} - #{t}.pdf",
+             "#{y} #{a} #{t}.pdf",
+             "#{a}_#{y}_#{t}.pdf".gsub(" ", "_"),
+             "#{au}_#{y}_#{t}.pdf".gsub(" ", "_"),
+             "#{ad}_#{y}_#{t}.pdf".gsub(" ", "_"),
+             "#{a} #{y} #{t}.pdf",
+             "#{au} #{y} #{t}.pdf",
+             "#{ad} #{y} #{t}.pdf",
+           ]
   end
 
-  private
   # Pass in an array to list and be selected, and return the element that the
-  # user selects back to the calling method. pretty sketchy way to interpret
-  # the users input as a range or integer, but seems to be working for now.
-  # requires you to check for an array and join it on the downside though
-  def choose(options, print: true)
-    if options.length > 0
-      options.each_with_index {|l, i| puts "#{i}\t#{l}" } if print
-      printf "[0 - #{options.length-1}]: ".bow
-      line = STDIN.gets.chomp || 0
-      meta = "options[#{line}]"
-      mout = eval meta # in theory terrible but this ain't a rails app.....
-      if mout.is_a? (Array)
-        mout.join ' '
-      else
-        mout
+  # user selects back to the calling method. this is a way to interpret
+  # the users input as a range (e.g., 0..2) or an integer (1).
+  def choose(list, print: true)
+    raise "List is empty." if list.empty?
+
+    if @options[:auto]
+      line = 0
+    else
+      # Never print when --auto.
+      if print
+        list.each_with_index { |l, i| puts "#{i}\t#{l}" }
+        printf "[0 - #{options.length - 1}]: "
       end
+      line = STDIN.gets.chomp || 0
     end
+
+    meta = "list[#{line}]"
+    mout = eval meta
+    mout.join " " if mout.is_a? (Array)
+    mout
   end
 
   # Generate different forms for author selection, enumerating the different
   # author that you want to save the file as. Split based on a comma.
   def gen_authors(aline)
-    lines = aline.split(", ").map {|a| a.sub(/\d$/, '') } # delete ref number.
+    lines = aline.split(", ").map { |a| a.sub(/\d$/, "") } # delete ref number.
     if lines.is_a?(String)
-      aline # return first
+      aline
     else # its an array, augment w/ lname and choose
-      alines = lines.map {|a| a.split.last } + lines
+      alines = lines.map { |a| a.split.last } + lines
       choose alines
     end
   end
 
-  # parse out a year from a string, for each line of the document until found.
-  # then clean it up and return it
+  # Parse out a year from a string, for each line of the document until found.
+  # Then clean it up and return it.
   def gen_year
-    @fulltxt.each do |l| # find year
+    @full_text.each do |l| # find year
       lm = l.match(/(19|20)\d\d/)
       return lm[0] if !lm.nil?
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SR
-  Version = "0.3.7"
+  Version = "0.4.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scholar-rename
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeremy Warner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: 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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +54,7 @@ homepage: http://github.com/jeremywrnr/scholar-rename
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Rename pdfs based on author/title/year.
 test_files: []