propre 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8d4f8827aec0bc2ce9ff3581aa69e2b46973790
-  data.tar.gz: a7a6f9ec7d86dac0d7344e5666189e305bbf0fdf
+  metadata.gz: 1966bbf10fe1b01355b2a2ab9cf14472b994a12e
+  data.tar.gz: 1be84abd1cb76629138b985d65447a0744c36aa8
 SHA512:
-  metadata.gz: fd7ceed35a8411953d75aa74a088349c16649786b4ad4fb933cf247792665e8896deac8d9bd4855f85cdf12260be6d14b0a4f188057620cda4b572cf560115dc
-  data.tar.gz: b56cfb345dd0888fa1ecfe176757bd0ce3a9967db5c38508b9836a786e77276c047f484d6e59563f77d1468e075b5536b27d63acafb59e9cda264411b0b68f4c
+  metadata.gz: 5c7b3a04b21448056a138f033264c32ff1ec3460acb39f2c2d45365f8d45c00a5ab9fdd969dd035833dc205c1dabd378b3b5d206a4388a8f58bb9d2ea551143d
+  data.tar.gz: 9b6a4e71a02ade3b95b61d5c341664fc6bab239dd15c065e814ebe5cd03fe1e3644bff0df6f745dbe47f899f45e3faf80deca32d8ab4a1ac1332976a2134ffec

data/README.md

@@ -7,29 +7,29 @@ Propre
 
 ##Introduction
 
-**Propre** is a handy tool written in Ruby to bulk rename your movies using [TheMovieDB](https://www.themoviedb.org/) API.
+**Propre** is a handy tool written in Ruby to bulk rename your movies.
 
-Propre will extract the title of a movie from it's filename and then rename it based on search result from TMDB.
+Propre will extract the title of a movie from it's filename and then rename it by removing any useless part.
 
 ##Installation
 
     gem install propre
 
-To use Propre, you need an API Key from TheMovieDB. Get your API key [here](https://www.themoviedb.org/account).
-
 ##Usage
 
-    Usage: propre [OPTION]... SOURCE...
-        -i, --interactive                Run interactively
-        -R, --recursive                  Run recursively
-        -V, --video-only                 Search for video files only
-        -s, --sanitize                   Sanitize filename before search
-        -d, --dotfile                    Don't ignore .dotfile
-        -v, --version                    Show version information about this program and quit.
-        -h, --help, --usage              Show this help message and quit.
+  Commands:
+    propre --version, -v        # Show version information about this program and quit.
+    propre help [COMMAND]       # Describe available commands or one specific command
+    propre lint [FILENAME...]   # Sanitize the specified file. Use --dry for dry run
+    propre metadata [FILENAME]  # Show metadata about the specified movie or episode
 
 ##Changelog
 
+### 0.2.0
+
+  - Complete rewrite with Thor
+  - Removing the use of TMDB since search result wasn't successful
+
 ### 0.1.1
 
   - Fix bug when no movie was found

data/bin/propre

@@ -1,72 +1,44 @@
 #!/usr/bin/env ruby
+require 'thor'
 
 lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
-require 'optparse'
 require 'propre'
-
-options = {}
-OptionParser.new do |opt|
-  opt.banner = "Usage: #{ File.basename($0) } [OPTION]... SOURCE..."
-
-  opt.on('-i', '--interactive', 'Run interactively') do |v|
-    options[:interactive] = v
-  end
-
-  opt.on('-R', '--recursive', 'Run recursively') do |v|
-    options[:recursive] = v
-  end
-
-  opt.on('-V', '--video-only', 'Search for video files only') do |v|
-    options[:videonly] = v
-  end
-
-  opt.on('-s', '--sanitize', 'Sanitize filename before search') do |v|
-    options[:sanitize] = v
-  end
-
-  opt.on('-d', '--dotfile', 'Don\'t ignore .dotfile') do |v|
-    options[:dotfile] = v
-  end
-
-  opt.on_tail("-v", "--version", "Show version information about this program and quit.") do
-    puts "#{Propre} - v#{Propre::VERSION}"
-    exit
+require 'propre/version'
+
+class CLI < Thor
+  include Propre
+  desc 'lint [FILENAME...]', 'Sanitize the specified file. Use --dry for dry run'
+  option :dry,    type: :boolean
+  option :color,  type: :boolean, default: true
+  def lint(*args)
+    String.disable_colorization(true) unless options[:color]
+    args.each do |filename|
+      basename, newname, metadata = Propre.basename_newname_metadata(filename)
+      if options[:dry]
+        unchanged = basename == newname ? :green : :yellow
+        puts "#{filename} -> #{newname}#{File.extname(filename)}".colorize(unchanged)
+      else
+        File.rename(filename, "#{newname}#{File.extname(filename)}")
+      end
+    end
   end
+  default_task :lint
 
-  opt.on_tail("-h", "--help", "--usage", "Show this help message and quit.") do |v|
-    puts opt.help
-    exit
+  desc 'metadata [FILENAME]', 'Show metadata about the specified movie or episode'
+  option :format, default: 'json'
+  def metadata(filename)
+    basename, newname, metadata = Propre.basename_newname_metadata(filename)
+    metadata[:title] = newname
+    puts metadata.to_json
   end
 
-  options[:help] = opt.help
-
-end.parse!
-
-def main(options)
-  if ARGV.size < 1
-    puts options[:help]
-  else
-    propre = Propre.new(options)
-    if File.directory?(ARGV[0])
-      puts "Searching for movies in directory..."
-      propre.crawlDirectory(ARGV[0])
-    end
-
-    if File.file?(ARGV[0])
-      puts "Searching for movie title..."
-      if !propre.searchMovieFromFile(ARGV[0])
-        puts "No movie found for #{ARGV[0]}"
-      end
-    end
+  map %w(--version -v) => :__version
+  desc '--version, -v', 'Show version information about this program and quit.'
+  def __version
+    puts "#{Propre} - v#{Version::VERSION}"
   end
 end
 
-begin
-  main(options)
-rescue Interrupt
-  puts "\nExiting..."  
-rescue StandardError => e
-  puts e
-end
+CLI.start(ARGV)

data/lib/propre/blacklist.rb

@@ -0,0 +1,12 @@
+module Blacklist
+  WORDS = %w(
+    dvd
+    rip
+    xvid
+    hdtv
+    bluray
+    fastsub
+    vostfr
+    ac3
+  )
+end

data/lib/propre/version.rb

@@ -1,3 +1,3 @@
 module Version
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/propre.rb

@@ -1,97 +1,72 @@
-require 'propre/prompt'
-require 'propre/settings'
-require 'propre/version'
+require 'json'
+require 'colorize'
 
-require 'fileutils'
-require 'themoviedb'
-require 'mime/types'
-require 'similar_text'
+require 'propre/blacklist'
 
-class Propre
-  include Prompt
-  include Version
+module Propre
+  def self.propify(arg)
+    ban_words(ban_chars(sanitize(remove_patterns(arg.downcase)))).split.map(&:capitalize).join(' ')
+  end
 
-  def initialize(options)
-    @options = options
-    @settings = Settings.new("#{Dir.home}/.config/Propre/settings.yaml")
-    if @settings.get('apikey').nil?
-      puts "It's seem you didn't set your TMDB API Key (stored in ~/.config/Propre/settings.yaml) \nPlease tell me: "
-      @settings.set('apikey', STDIN.gets.chomp())
-      puts "Thanks !"
-    end
-    Tmdb::Api.key(@settings.get('apikey'))
-    Tmdb::Api.language(@settings.get('locale') ? @settings.get('locale') : 'en')
+  def self.find_urls(arg)
+    arg = arg.match '((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)'
+    arg.to_s
   end
 
-  def crawlDirectory(path)
-    Dir.foreach(path) do |item|
-      next if item == '.' or item == '..'
-      if File.directory?(File.join(path, item))
-        if @options[:recursive] then self.crawlDirectory(File.join(path, item)) end
-      else
-        self.searchMovieFromFile(File.join(path, item))
-      end
-    end
+  def self.find_years(arg)
+    arg = arg.match '((19|20)\d\d)'
+    arg.to_s
   end
 
-  def searchMovieFromFile(file)
-    @file = file
-    filename = File.basename(file,File.extname(file))
-    if @options[:videonly] && !video?(file)
-      return
-    end
-    if !@options[:dotfile] && filename.start_with?('.')
-      return
-    end
-    if @options[:sanitize] then filename = self.sanitize(filename) end
-    begin
-      @movies = Tmdb::Movie.find(filename)
-    rescue
-      if Tmdb::Api.response['code'] === 401
-        abort("Error: Did you set you're API Key ? (401)")
-      end
-    end
-    if @movies.empty? then return false end
-    @movies = @movies.sort { |a,b| b.release_date <=> a.release_date }
-    movie = @movies.max_by {|v| filename.similar(v.title)}
-    @movies.delete(@movies.index(movie))
-    @movies.unshift(movie)
-    if self.confirm
-      File.rename(file, File.join(File.dirname(file), self.format(@selected)))
-    end
+  def self.find_episode(arg)
+    arg = arg.match '(s\d{1,2}e\d{2,3})'
+    arg.to_s
   end
 
-  def confirm()
-    @selected = false
-    @movies.each do |movie|
-      answer = Prompt.yesno("#{File.basename(@file)} -> #{self.format(movie)}")
-      if answer === false; next ; elsif answer === 'skip'; puts "Skipping..."; return end
-      @selected = movie
-      break
-    end
-    if @selected then @selected end
+  def self.remove_patterns(arg)
+    arg.slice! find_urls(arg)
+    arg.slice! find_years(arg)
+    arg.slice! find_episode(arg)
+    arg
+  end
+
+  def self.sanitize(arg)
+    arg.gsub('.', ' ').strip
   end
 
-  def format(movie)
-    year = !movie.release_date.empty? ? Date.strptime(movie.release_date, "%Y-%m-%d").year : false
-    title = year ? "#{movie.title} (#{year})" : "#{movie.title}"
-    title.gsub! ':','-'
-    return "#{title}#{File.extname(@file).downcase}"
+  def self.ban_chars(arg)
+    arg.tr('^A-Za-z0-9 ', '').strip
   end
 
-  def sanitize(filename)
-    filename.downcase!
-    filename.gsub!(/\(.*\)/, '')
-    filename.gsub!("_", ' ')
-    filename.gsub!(".", ' ')
-    filename.sub!(/(19|20)\d{2}/, '')
-    filename.strip!
-    warez = ["truefrench","brrip", "ac3-funky", "fansub","bluray","720", "720p", "x264","french", "fr", "divx","hdcam","xvid","appz","bdrip","board","cam","dvd","dvd-r","dvdrip","dupecheck","fake","fs","gamez","hddvd","hddvdrip","hdrip","hdtv","pdtv","internal","int","keygen","leecher","limited","nuke","proper","repack","retail","rip","rip","screener","serial","subforced","hardsub","stv","telecine","telesync","tvrip","unrated","vhsrip","vo","vost","vostfr","workprint","french","wp","subbed","unsubbed", "r5", "r6", "md"]  
-    (filename.split - warez).join(' ')
+  def self.ban_words(arg)
+    arg.split.each do |word|
+      Blacklist::WORDS.select do |e|
+        arg.slice! word if word.include? e
+      end
+    end
+    arg.squeeze(' ')
   end
 
-  def video?(file)
-    MIME::Types[/^video/].include? MIME::Types.of(file)
+  def self.metadata(arg)
+    arg = arg.downcase
+    {
+      year: find_years(arg),
+      episode: find_episode(arg).upcase,
+      website: find_urls(arg)
+    }
   end
 
-end
+  def self.format(newname, metadata)
+    metadata[:newname] = newname
+    metadata[:year] = "(#{metadata[:year]})" unless metadata[:year].empty?
+
+    format = '%{newname} %{episode} %{year}'
+    formated = format % metadata
+    formated.strip.squeeze(' ')
+  end
+
+  def self.basename_newname_metadata(arg)
+    basename = File.basename(arg, File.extname(arg))
+    [basename, format(propify(basename), metadata(basename)), metadata(basename)]
+  end
+end

data/propre.gemspec

@@ -4,24 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'propre/version'
 
 Gem::Specification.new do |spec|
-  spec.authors       = ["Felix Yadomi"]
-  spec.email         = ["dev.yadomi@gmail.com"]
+  spec.authors       = ['Felix Yadomi']
+  spec.email         = ['dev.yadomi@gmail.com']
 
-  spec.name          = "propre"
+  spec.name          = 'propre'
   spec.version       = Version::VERSION
-  spec.summary       = %q{CLI tool to rename movies using TheMovieDB API }
+  spec.summary       = 'CLI tool to sanitize movies filename'
 
-  spec.files         = `git ls-files`.split($\)
+  spec.files         = `git ls-files`.split($ORS)
   spec.executables   = ['propre']
-  spec.require_paths = ["lib"]
-  
-  spec.add_dependency "parseconfig", "~> 1.0.6"
-  spec.add_dependency "themoviedb", "~> 0.0.24"
-  spec.add_dependency "mime-types", "~> 2.4.3"
-  spec.add_dependency "highline", "~> 1.6.21"
-  spec.add_dependency "similar_text", "~> 0.0.4"
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'json', '~> 1.8.3'
+  spec.add_dependency 'colorize', '~> 0.7.7'
 
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,111 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: propre
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Felix Yadomi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: parseconfig
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
-  name: themoviedb
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.24
+        version: 1.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.24
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.3
+        version: 0.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.3
-- !ruby/object:Gem::Dependency
-  name: highline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.21
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.21
-- !ruby/object:Gem::Dependency
-  name: similar_text
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: 
@@ -116,14 +88,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - README.md
 - Rakefile
 - bin/propre
 - lib/propre.rb
-- lib/propre/prompt.rb
-- lib/propre/settings.rb
+- lib/propre/blacklist.rb
 - lib/propre/version.rb
 - propre.gemspec
 homepage: 
@@ -135,18 +106,18 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: CLI tool to rename movies using TheMovieDB API
+summary: CLI tool to sanitize movies filename
 test_files: []

data/lib/propre/prompt.rb

@@ -1,16 +0,0 @@
-require 'highline/import'
-
-module Prompt
-
-  def Prompt.yesno(prompt = 'Continue?', default = false)
-    a = ''
-    s = default ? '[Y/n/s]' : '[y/N/s]'
-    d = default ? 'y' : 'n'
-    until %w[y n s].include? a
-      a = ask("#{prompt} #{s} ") { |q| q.limit = 1; q.case = :downcase }
-      a = d if a.length == 0
-    end
-    if a == 'y'; true elsif a == 's'; 'skip' else false end
-  end
-
-end

data/lib/propre/settings.rb

@@ -1,25 +0,0 @@
-require 'yaml'
-require 'parseconfig'
-
-class Settings
-
-  def initialize(path)
-    @path = path
-    if !File.exist?(path) 
-      FileUtils.mkdir_p("#{Dir.home}/.config/Propre/")
-      FileUtils.touch(path)
-    end
-    conf = YAML.load_file(path)
-    @settings = conf ? conf : Hash.new
-  end
-
-  def get(key)
-    @settings[key]
-  end
-
-  def set(key, value)
-    @settings[key] = value
-    File.open(@path, 'w') { |f| YAML.dump(@settings, f) }
-  end
-
-end