iml 0.1.6 → 0.2.0

data/README.md

@@ -1,25 +1,23 @@
 [![Gem Version](https://img.shields.io/gem/v/iml.svg)](https://rubygems.org/gems/iml)
-[![build status](https://travis-ci.org/aladac/iml.svg?branch=master)](https://travis-ci.org/aladac/iml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/232800c6e4d8778937b2/maintainability)](https://codeclimate.com/github/aladac/iml/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/232800c6e4d8778937b2/test_coverage)](https://codeclimate.com/github/aladac/iml/test_coverage)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/aladac/iml/master)
 
 [![IML](https://github.com/aladac/iml/raw/master/doc/iml-logo.png)](https://rubygems.org/gems/iml)
 
 *Intricate (Media) Matching Logic*
 
-This is a media file handling library which is supposed to "guess" the intended type of media file based on specific naming patterns.
-Its main purpose is to serve as runtime for renaming media files according to specified patterns.
-The gem includes an executable `iml` through which rename operations are possible.
+A media file handling library that detects the type of media file based on naming patterns.
+It parses filenames into structured objects and renames files according to configurable format strings.
+Includes an `iml` CLI for batch rename operations.
+
+**Zero runtime dependencies.**
 
 ## Installation
 
-This gem requires ruby >= 2.4
+Requires Ruby >= 3.1
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'iml'
+gem "iml"
 ```
 
 And then execute:
@@ -38,24 +36,82 @@ Or install it yourself as:
 Usage: iml [options] MEDIA_FILE [MEDIA_FILE] ...
     -v, --[no-]verbose               Run verbosely
     -p, --[no-]pretend               Dry run, do not move any files
-    -t, --target PATH                Path to move media files to, default: current directory
-    -o, --movie-format FORMAT        Format of the output path of movies, default: '%T (%Y).%f'
-    -O, --tv-format FORMAT           Format of the output path of TV series, default: '%T/Season %s/%T - S%SE%E.%f'
-    -l, --list-formats               Format description
-    -f, --force                      Use the force, override output files
-
-$ iml -v Some.Cool.Movie.2018.1080p.BRRip.x264.aac-GROUP.mp4
-I, [2018-07-06T13:38:29.836887 #70771]  INFO -- : Some.Cool.Movie.2018.1080p.BRRip.x264.aac-GROUP.mp4 looks like a movie
-I, [2018-07-06T13:38:29.837047 #70771]  INFO -- : Moving Some.Cool.Movie.2018.1080p.BRRip.x264.aac-GROUP.mp4 to Some Cool Movie (2018).mp4
+    -t, --target PATH                Output directory (default: current directory)
+    -o, --movie-format FORMAT        Movie output format (default: '%T (%Y).%f')
+    -O, --tv-format FORMAT           TV series output format (default: '%T/Season %s/%T - S%SE%E.%f')
+    -l, --list-formats               Show format placeholders
+    -f, --force                      Overwrite existing output files
+    -V, --version                    Show version
+
+$ iml --pretend --verbose Some.Cool.Movie.2018.1080p.BRRip.x264.aac-GROUP.mp4
+movie: Some.Cool.Movie.2018.1080p.BRRip.x264.aac-GROUP.mp4 -> Some Cool Movie (2018).mp4
+done: 1 processed, 0 skipped
 ```
 
-### Code
+### Library
 
 ```ruby
-title = "An.Interesting.TV.Show.S01E01.1080p.WEBRIP.h265-GROUP.mkv"
-=> "An.Interesting.TV.Show.S01E01.1080p.WEBRIP.h265-GROUP.mkv"
-IML::Text.new(title).detect
-=> #<IML::TVSeries title="An Interesting Tv Show", season="01", episode="01", quality="1080p", source="WEBRIP", codec="h265", group="GROUP", extension="mkv">
+require "iml"
+
+# Parse a movie filename
+movie = IML.parse("Cool.Movie.2018.720p.BluRay.H264.AAC2.0-GROUP.mp4")
+movie.class     #=> IML::Media::Movie
+movie.title     #=> "Cool Movie"
+movie.year      #=> "2018"
+movie.codec     #=> "h.264"
+movie.source    #=> "BD"
+movie.movie?    #=> true
+
+# Parse a TV series filename
+tv = IML.parse("Show.Name.S03E09.WEBRip.x264-GROUP.mkv")
+tv.class        #=> IML::Media::TvSeries
+tv.title        #=> "Show Name"
+tv.season       #=> "03"
+tv.season_i     #=> 3
+tv.episode_i    #=> 9
+tv.tv?          #=> true
+
+# Format output paths
+formatter = IML::Formatter.new
+formatter.call(movie)                          #=> "Cool Movie (2018).mp4"
+formatter.call(movie, format: "%T/%T.%Y.%f")  #=> "Cool Movie/Cool Movie.2018.mp4"
+formatter.pathname(movie, target: "/media")    #=> #<Pathname:/media/Cool Movie (2018).mp4>
+
+# Move files
+mover = IML::FileMover.new
+mover.call("source.mp4", movie, target: "/media", pretend: true)
+```
+
+### Format Placeholders
+
+| Placeholder | Description |
+|-------------|-------------|
+| `%T` | Title |
+| `%t` | Episode title |
+| `%Y` | Year |
+| `%S` | Season (string, e.g. "03") |
+| `%s` | Season (integer, e.g. "3") |
+| `%E` | Episode (string, e.g. "09") |
+| `%e` | Episode (integer, e.g. "9") |
+| `%v` | Video codec |
+| `%a` | Audio codec |
+| `%q` | Quality |
+| `%z` | Source |
+| `%g` | Group |
+| `%f` | File extension |
+
+## Architecture
+
+```
+IML.parse(filename)
+  -> IML::Parser
+       -> IML::PatternBuilder  (builds regex from patterns.yml)
+       -> IML::Normalizer      (normalizes codecs, sources, titles)
+       -> IML::Media::Movie or IML::Media::TvSeries
+
+IML::Formatter    (formats output paths from media objects)
+IML::FileMover    (moves files using Formatter)
+IML::Configuration (loads patterns.yml)
 ```
 
 ## License

data/Rakefile

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc 'Console'
+desc "Console"
 task :console do
-  require 'bundler/setup'
-  require 'iml'
-  require 'pry'
-  Pry.start
+  require "bundler/setup"
+  require "iml"
+  require "irb"
+  IRB.start
 end
 
-task default: :spec
+task default: %i[spec standard]

data/TODO.md

@@ -0,0 +1,43 @@
+# TODO: IML Gem Comprehensive Refactor
+
+## Phase 1: Modernize Dependencies and Tooling
+- [x] Step 1.1: Update Ruby version requirement and gemspec
+- [x] Step 1.2: Replace Travis CI with GitHub Actions
+- [x] Step 1.3: Switch linting to StandardRB
+- [x] Step 1.4: Update Gemfile and run bundle install
+
+## Phase 2: Architecture Rewrite — Composition Over Inheritance
+- [x] Step 2.1: Create Configuration module (replace IML::Hash)
+- [x] Step 2.2: Rewrite Pattern Builder (remove method_missing)
+- [x] Step 2.3: Create Media Result value objects (replace OpenStruct)
+- [x] Step 2.4: Create Formatter service
+- [x] Step 2.5: Create Normalizer service
+- [x] Step 2.6: Rewrite Parser (replace IML::Text < String)
+- [x] Step 2.7: Create File Mover service
+- [x] Step 2.8: Update main entry point (lib/iml.rb)
+- [x] Step 2.9: Delete legacy files
+
+## Phase 3: CLI Modernization
+- [x] Step 3.1: Rewrite CLI script (add --version, remove tqdm, proper exit codes)
+
+## Phase 4: Remove ActiveSupport Dependency
+- [x] Step 4.1: Replace ActiveSupport Inflector with lightweight titleize
+- [x] Step 4.2: Remove HashWithIndifferentAccess usage
+- [x] Step 4.3: Remove activesupport from gemspec
+
+## Phase 5: Comprehensive Test Suite
+- [x] Step 5.1: Set up test infrastructure (spec_helper, :verified tags)
+- [x] Step 5.2: Test Configuration
+- [x] Step 5.3: Test Pattern Builder
+- [x] Step 5.4: Test Parser
+- [x] Step 5.5: Test Media Result objects (Movie, TvSeries)
+- [x] Step 5.6: Test Formatter
+- [x] Step 5.7: Test Normalizer
+- [x] Step 5.8: Test File Mover
+- [x] Step 5.9: Delete legacy tests
+
+## Phase 6: Final Cleanup and Verification
+- [x] Step 6.1: Run StandardRB and fix issues
+- [x] Step 6.2: Run full test suite
+- [x] Step 6.3: Build and verify gem
+- [x] Step 6.4: Update README

data/bin/iml

@@ -1,96 +1,106 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'iml'
-require 'optparse'
+require "iml"
+require "optparse"
 
 options = {}
-@logger = Logger.new(STDOUT)
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] MEDIA_FILE [MEDIA_FILE] ..."
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") { |v| options[:verbose] = v }
+  opts.on("-p", "--[no-]pretend", "Dry run, do not move any files") { |p| options[:pretend] = p }
+  opts.on("-t", "--target PATH", "Output directory (default: current directory)") { |t| options[:target] = t }
+  opts.on("-o", "--movie-format FORMAT", "Movie output format (default: '#{IML::Media::Movie::DEFAULT_FORMAT}')") { |f| options[:movie_format] = f }
+  opts.on("-O", "--tv-format FORMAT", "TV series output format (default: '#{IML::Media::TvSeries::DEFAULT_FORMAT}')") { |f| options[:tv_format] = f }
+  opts.on("-l", "--list-formats", "Show format placeholders") { options[:list_formats] = true }
+  opts.on("-f", "--force", "Overwrite existing output files") { options[:force] = true }
+  opts.on("-V", "--version", "Show version") do
+    puts "iml #{IML::VERSION}"
+    exit
+  end
+end
 
 begin
-  OptionParser.new do |opts|
-    opts.banner = "Usage: #{File.basename $PROGRAM_NAME} [options] MEDIA_FILE [MEDIA_FILE] ..."
-
-    opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
-      options[:verbose] = v
-    end
-    opts.on('-p', '--[no-]pretend', 'Dry run, do not move any files') do |p|
-      options[:pretend] = p
-    end
-    opts.on('-t', '--target PATH', 'Path to move media files to, default: current directory') do |t|
-      options[:target] = t
-    end
-    opts.on('-o', '--movie-format FORMAT', "Format of the output path of movies, default: '#{IML::Movie::DEFAULT_FORMAT}'") do |f|
-      options[:movie_format] = f
-    end
-    opts.on('-O', '--tv-format FORMAT', "Format of the output path of TV series, default: '#{IML::TVSeries::DEFAULT_FORMAT}'") do |f|
-      options[:tv_format] = f
-    end
-    opts.on('-l', '--list-formats', 'Format description') do |f|
-      options[:format] = f
-    end
-    opts.on('-f', '--force', 'Use the force, override output files') do |f|
-      options[:force] = f
-    end
-    puts opts if opts.default_argv.empty? && STDIN.tty?
-  end.parse!
+  parser.parse!
 rescue OptionParser::InvalidOption => e
-  @logger.error e.message
+  $stderr.puts e.message
+  exit 1
 end
 
-if options[:format]
-  puts <<~FORMAT
-    Formatting description:
-    %T - title
-    %t - episode title
-    %Y - year
-    %S - season number string as found in the input path
-    %s - season number integer
-    %E - episode number string as found in the input path
-    %e - episode number integer
-    %g - group name
-    %a - audio codec
-    %v - video codec
-    %f - file format / extension
-    %z - source
-    %q - quality
+if $stdin.tty? && ARGV.empty?
+  puts parser
+  exit
+end
 
+if options[:list_formats]
+  puts <<~FORMAT
+    Format placeholders:
+      %T - title
+      %t - episode title
+      %Y - year
+      %S - season number (string, e.g. "03")
+      %s - season number (integer, e.g. "3")
+      %E - episode number (string, e.g. "09")
+      %e - episode number (integer, e.g. "9")
+      %g - group name
+      %a - audio codec
+      %v - video codec
+      %f - file extension
+      %z - source
+      %q - quality
   FORMAT
   exit
 end
 
-input = STDIN.tty? ? ARGV : $stdin.readlines
-
-input ||= ARGV
-
-def file_operations(path, media, options)
-  pathname = media.pathname
-  dirname = pathname.dirname
-  unless dirname.to_s == '.'
-    @logger.info "Creating #{dirname}" if options[:verbose] || options[:pretend]
-    media.create_dir
-  end
-  @logger.info "Moving #{path} to #{pathname}" if options[:verbose] || options[:pretend]
-  media.move(path)
+input = if ARGV.any?
+  ARGV
+elsif !$stdin.tty?
+  $stdin.readlines
+else
+  []
 end
+media_parser = IML::Parser.new
+formatter = IML::Formatter.new
+mover = IML::FileMover.new(formatter: formatter)
+
+processed = 0
+skipped = 0
 
-input.map { |p| Pathname(p.chomp) }.tqdm(desc: 'Processing input', leave: true).each do |path|
+input.each do |entry|
+  path = Pathname(entry.chomp)
   filename = path.basename.to_s
+
   unless path.exist?
-    @logger.warn("File #{path} does not exist, skipping")
+    $stderr.puts "skip: #{path} (file not found)"
+    skipped += 1
     next
   end
-  media = IML::Text.new(filename, options).detect
+
+  media = media_parser.parse(filename)
   unless media
-    @logger.warn "#{path} doesn't look like a media file" if options[:verbose] || options[:pretend]
+    $stderr.puts "skip: #{path} (not recognized)" if options[:verbose] || options[:pretend]
+    skipped += 1
     next
   end
-  if media.movie?
-    media.format_string = options[:movie_format] if options[:movie_format]
-    @logger.info "#{path} looks like a movie"
-  elsif media.tv?
-    media.format_string = options[:tv_format] if options[:tv_format]
-    @logger.info "#{path} looks like a TV series"
+
+  format = media.movie? ? options[:movie_format] : options[:tv_format]
+  dest = formatter.pathname(media, format: format, target: options[:target])
+  type_label = media.movie? ? "movie" : "tv"
+
+  if options[:verbose] || options[:pretend]
+    $stderr.puts "#{type_label}: #{path} -> #{dest}"
+  end
+
+  unless options[:pretend]
+    mover.call(path, media, format: format, target: options[:target])
   end
-  file_operations(path, media, options)
+
+  processed += 1
+rescue IML::FileNotFoundError => e
+  $stderr.puts "error: #{path} (#{e.message})"
+  skipped += 1
 end
+
+$stderr.puts "done: #{processed} processed, #{skipped} skipped" if options[:verbose] || options[:pretend]

data/gemspec.yml

@@ -1,12 +1,9 @@
-dependencies:
-  activesupport: ~> 5.2
-  tqdm: ~> 0.3
+dependencies: {}
 
 development_dependencies:
-  codeclimate-test-reporter: ~> 1.0
-  bundler: ~> 1.16
-  rake: ~> 12.3
-  rspec: ~> 3.7
-  pry: ~> 0.11
-  simplecov: ~> 0.16
-  yard: ~> 0.9
+  bundler: '>= 2.4'
+  rake: '~> 13.0'
+  rspec: '~> 3.13'
+  simplecov: '~> 0.22'
+  standard: '~> 1.40'
+  yard: '~> 0.9'

data/iml.gemspec

@@ -1,48 +1,39 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'iml/version'
-require 'yaml'
+require "iml/version"
+require "yaml"
 
 Gem::Specification.new do |spec|
-  gemspec = YAML.load_file('gemspec.yml')
-  spec.name          = 'iml'
-  spec.version       = IML::VERSION
-  spec.authors       = ['Adam Ladachowski']
-  spec.email         = ['adam.ladachowski@gmail.com']
-
-  spec.summary       = 'Media string and object manipulation library'
-  spec.description   = 'Library which parses strings into media objects'
-  spec.homepage      = 'https://github.com/aladac/iml'
-  spec.license       = 'MIT'
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
+  gemspec = YAML.safe_load_file("gemspec.yml")
+  spec.name = "iml"
+  spec.version = IML::VERSION
+  spec.authors = ["Adam Ladachowski"]
+  spec.email = ["adam.ladachowski@gmail.com"]
+
+  spec.summary = "Media string and object manipulation library"
+  spec.description = "Library which parses strings into media objects"
+  spec.homepage = "https://github.com/aladac/iml"
+  spec.license = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["yard.run"] = "yri"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.4'
-  spec.metadata['yard.run'] = 'yri'
+  spec.required_ruby_version = ">= 3.1"
 
-  gemspec['dependencies'].each do |name, version|
+  gemspec["dependencies"].each do |name, version|
     spec.add_dependency(name, version)
   end
 
-  gemspec['development_dependencies'].each do |name, version|
+  gemspec["development_dependencies"].each do |name, version|
     spec.add_development_dependency(name, version)
   end
 end

data/lib/iml/configuration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class IML::Configuration
+  attr_reader :data
+
+  def initialize(path = nil)
+    path ||= default_path
+    @data = YAML.safe_load_file(path, permitted_classes: [Symbol])
+  end
+
+  def codec_map
+    @codec_map ||= data.fetch("codec", {})
+  end
+
+  def audio_map
+    @audio_map ||= data.fetch("audio", {})
+  end
+
+  def source_map
+    @source_map ||= data.fetch("source", {})
+  end
+
+  def quality_list
+    @quality_list ||= data.fetch("quality", [])
+  end
+
+  def extension_list
+    @extension_list ||= data.fetch("extension", [])
+  end
+
+  def pattern_for(field)
+    value = data.fetch(field.to_s)
+
+    case value
+    when Hash
+      "(?<#{field}>(#{value.keys.join("|")}))"
+    when Array
+      "(?<#{field}>(#{value.join("|")}))"
+    when String
+      "(?<#{field}>#{value})"
+    end
+  end
+
+  private
+
+  def default_path
+    File.expand_path("../../patterns.yml", __dir__)
+  end
+end

data/lib/iml/file_mover.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class IML::FileMover
+  def initialize(formatter: IML::Formatter.new)
+    @formatter = formatter
+  end
+
+  def call(source_path, media, format: nil, target: nil, pretend: false)
+    dest = @formatter.pathname(media, format: format, target: target)
+
+    unless pretend
+      FileUtils.mkdir_p(dest.dirname)
+      FileUtils.mv(source_path.to_s, dest.to_s)
+    end
+
+    dest
+  rescue Errno::ENOENT => e
+    raise IML::FileNotFoundError, e.message
+  end
+end

data/lib/iml/formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class IML::Formatter
+  def call(media, format: nil)
+    format_string = format || media.class::DEFAULT_FORMAT
+    media.class::PLACEHOLDERS.each do |placeholder, attribute|
+      format_string = format_string.gsub(placeholder, media.send(attribute).to_s)
+    end
+    format_string
+  end
+
+  def pathname(media, format: nil, target: nil)
+    formatted = call(media, format: format)
+    target ? Pathname(target) + Pathname(formatted) : Pathname(formatted)
+  end
+end

data/lib/iml/media/movie.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class IML::Media::Movie
+  ATTRIBUTES = %i[title year quality source codec audio channels group extension].freeze
+
+  PLACEHOLDERS = {
+    "%T" => :title,
+    "%Y" => :year,
+    "%f" => :extension,
+    "%v" => :codec,
+    "%a" => :audio,
+    "%g" => :group,
+    "%z" => :source,
+    "%q" => :quality
+  }.freeze
+
+  DEFAULT_FORMAT = "%T (%Y).%f"
+
+  attr_reader(*ATTRIBUTES)
+
+  def initialize(**attrs)
+    ATTRIBUTES.each { |a| instance_variable_set(:"@#{a}", attrs[a]) }
+  end
+
+  def movie? = true
+
+  def tv? = false
+
+  def type = :movie
+end

data/lib/iml/media/tv_series.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class IML::Media::TvSeries
+  ATTRIBUTES = %i[
+    title season episode episode_title quality source
+    codec audio channels group extension
+  ].freeze
+
+  PLACEHOLDERS = {
+    "%T" => :title,
+    "%E" => :episode,
+    "%S" => :season,
+    "%f" => :extension,
+    "%e" => :episode_i,
+    "%s" => :season_i,
+    "%t" => :episode_title,
+    "%a" => :audio,
+    "%v" => :codec,
+    "%q" => :quality,
+    "%g" => :group,
+    "%z" => :source
+  }.freeze
+
+  DEFAULT_FORMAT = "%T/Season %s/%T - S%SE%E.%f"
+
+  attr_reader(*ATTRIBUTES)
+
+  def initialize(**attrs)
+    ATTRIBUTES.each { |a| instance_variable_set(:"@#{a}", attrs[a]) }
+  end
+
+  def movie? = false
+
+  def tv? = true
+
+  def type = :tv
+
+  def season_i
+    season.to_i
+  end
+
+  def episode_i
+    episode.to_i
+  end
+end