scholar-rename 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d039aaa0b17ca8cbc90f85c2451bddece6057ddb
-  data.tar.gz: 4815af5eb0879eeabd6cae2b460e2bc9ddde8676
+  metadata.gz: 79107ab113b4a37427bee2fd9a2996a46ec3bbc4
+  data.tar.gz: 3b8f5e99e677875181da3d34782b558894ad2fd5
 SHA512:
-  metadata.gz: 0e1b4510e462585608e88f6058c22565ca572d66dc55dcc4fb2858bb885800aa40094282b7a16cf9599f68132edfb5d19a8ecde839d3800e864d2a3acda41bea
-  data.tar.gz: 77bdc55ea52ac0c6fd3deff70ac13e61b8dd10419c986582f899ea566ca072e77a4451ee3e7f77e3f98cfb001d22d0f7b3d1680eeff0b0b7f48b68056ce96390
+  metadata.gz: cc6e359f1efebc07bce6d59f9202e7ded85a281d4ebb2b59698cfcbeadccb226e5d7ebfd8c996399742f2734fce7b4cde9f3b893b0b11503f2cc7e358f3d576f
+  data.tar.gz: 522fc2acf038c82ddf6b2c3ef783e540dafdf8c830a6d0064739c1503d067ea066ce4900b5acb1d81e6d6b84ac35a8e21ffcbed0961a6e636c619815e0fb0e08

data/lib/renamer.rb

@@ -3,32 +3,44 @@ class Renamer
     a1 = args.first
     @file = File.join(Dir.pwd, a1)
 
-    if @file == Dir.pwd.to_s + '/'
-      puts "scholar-rename: provide a file"
-    elsif a1 == "-v"
+    if a1 == "-v"
       puts SR::Version
+    elsif @file == Dir.pwd.to_s + '/'
+      puts "usage: scholar-rename [pdf_file]"
+      puts "please specify a pdf file"
+    elsif has_prereq?
+      puts "please install pdftotext to use scholar-rename"
+      puts "osx: brew install xpdf"
     else
       rename
     end
   end
 
-  def rename # move file based on users input
-    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 = File.read temp
+  def has_prereq?
+    system("pdftotext 2> /dev/null")
+    $?.success?
+  end
+
+  def rename
+    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}'")
 
     # Choose pdf qualities
     s = Selector.new(content)
     s.select_all # choose props
     printf "Ok? [Yn]: "
-    conf = STDIN.gets.chomp # confirm title
 
-    begin # file read in from first ARGV above
+    begin
+      conf = STDIN.gets.chomp # confirm title
       File.rename(@file, s.title) unless conf.match(/^(n|N).*/)
-    ensure # cleaning up @file cleanup from pdftotext
+    ensure
       puts "Cleaning up..."
-      File.delete(temp)
+      #File.delete(temp)
     end
   end
 end

data/lib/selector.rb

@@ -2,29 +2,40 @@
 # 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
 
   # take the first 10 lines of the pdftotext output and assign it to the
   # context class instance variable, use later when choosing selector
+  # https://stackoverflow.com/questions/9503554/
   def initialize(c)
-    @content = c.split("\n")[0..14].reject {|x| x.length < 2 }
+    @content = c.split("\n")[0..14]
+      .reject {|x| x.length < 2 }
+      .map {|x| x[0..100] } # trim
     @fulltxt = c.split("\n")
   end
 
   def select_all
-    puts "Select title line number:"
-    title = choose @content
+    puts "Options:".bow
+    @content.each_with_index {|l, i| puts "#{i}\t#{l}" }
+    printf "Select title line number ".bow
+    title = choose(@content, print: false)
 
-    puts "Select author line number:"
-    authors = choose @content
+    printf "Select author line number ".bow
+    authors = choose(@content, print: false)
 
-    puts "Select author form number:"
+    puts "Select author form:".bow
     author = gen_authors(authors)
 
     year = gen_year # just read it
 
-    puts "Select desired title format:"
+    puts "Select desired title:".bow
     @title = choose(gen_forms year, title, author)
   end
 
@@ -33,11 +44,11 @@ class Selector
   # 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(opts)
-    opts.each_with_index {|l, i| puts "#{i}\t#{l}" }
-    printf "Your selection [0 - #{opts.length-1}]: "
+  def choose(options, print: true)
+    options.each_with_index {|l, i| puts "#{i}\t#{l}" } if print
+    printf "[0 - #{options.length-1}]: ".bow
     line = STDIN.gets.chomp
-    meta = "opts[#{line}]"
+    meta = "options[#{line}]"
     mout = eval meta # in theory terrible but this aint a rails app............
     if mout.is_a? (Array)
       mout.join ' '
@@ -68,6 +79,7 @@ class Selector
     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(" ", "_"),

data/lib/version.rb

@@ -1 +1,3 @@
-module SR; Version = "0.1.2"; end
+module SR
+  Version = "0.1.4"
+end

data/readme.md

@@ -1,9 +1,25 @@
-# scholar-rename `interactive pdf-namer`
+# scholar-rename
 
-- prereq: pdftotext installation for text dump
-- renames a pdf file to author-title-year.pdf
-- or other formats based on your selection
-- by jeremy warner, fall 2016
+[![MIT](https://img.shields.io/npm/l/alt.svg?style=flat)](http://jeremywrnr.com/mit-license)
+[![Gem Version](https://badge.fury.io/rb/scholar-rename.svg)](https://badge.fury.io/rb/scholar-rename)
 
-You need this: https://en.wikipedia.org/wiki/Pdftotext
+an interactive pdf-renamer tool.
 
+## install
+
+    [sudo] gem install scholar-rename
+
+you'll also need: https://en.wikipedia.org/wiki/Pdftotext
+
+## about
+
+renames a pdf file to author-title-year.pdf or other formats based on your
+selection. there isn't actually anything scholarly about this tool, though
+academic people may find it useful for renaming pdfs that come in arbitrarily
+named file formats. services like mendeley kind of make this not super
+relevant. it helps when searching for a specific pdf and when labeling pdfs.
+
+## todo
+
+- only show index lines once
+- actually clean up tempfile

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: scholar-rename
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Jeremy Warner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2018-01-22 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
@@ -70,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rename pdfs based on author/title/year.