file_scan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30637764091ba4b39b8dc3ead21eb5e14963513083cb842641c1d0c79203c508
+  data.tar.gz: b1d5410407ef9ad147bae99ad9d897648ecfdbde52f9bb169c51585b07b74f01
+SHA512:
+  metadata.gz: d5d56dc43aff5bb568f747644061907fe0d261364bbed3048ca0b320899644b6d787fef0569b4675dcc813c4f1e0866668ceef2dc3d480a2f1f90205c7b0ff8b
+  data.tar.gz: 8c8dec2d713a17ea85d1fc3414f46735dede1f5a6d9cd7f5dd7ebda675ae9558f2206b8395e3a1000f49ebfa687a277bd4021155b6dd4a284a7eac123505544d

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in file_scanner.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    file_scan (0.1.0)
+      colorize (~> 0.8.1)
+      rake (~> 13.0)
+      rubocop (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    colorize (0.8.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  file_scan!
+
+BUNDLED WITH
+   2.2.27

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 anujchandra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "file_scanner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/file_scanner/client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module FileScanner
+  # Create a scanner client
+  #
+  # @author c477y
+  class Client
+    #
+    # Create a new Scanner
+    #
+    # @param [String] dir Directory to be processed
+    # @param [Hash] options
+    # @option options [Boolean] :nested Specify if nested directories should be scanned
+    # @option options [String] extension Extension of filenames to be selected. Defaults to "*.mp4"
+    def initialize(dir, **options)
+      @nested = options[:nested]
+      @extension = options[:extension].nil? ? "*.mp4" : options[:extension]
+      @dir = dir
+    end
+
+    # @param [Proc] block Block of code to be executed for each file
+    def each(&block)
+      @block = block
+      process_directory(@dir)
+    end
+
+    private
+
+    #
+    # Executes a block of code for all files in a given directory. Will scan files
+    # in sub-directories if @nested is passed as true
+    #
+    # @param [String] dir Directory path to scan
+    def process_directory(dir)
+      Dir.chdir(dir) do
+        # Process files in a given directory
+        print "Scanning files in #{Dir.pwd}\n".colorize(:blue)
+
+        Dir.glob(@extension).sort.each { |file| @block.call(file) }
+
+        # Return unless we want to scan the directories inside
+        # the directory `dir`
+        return unless @nested
+
+        nested_dir = Dir["*"].select { |o| File.directory?(o) }
+        nested_dir.sort.each do |each|
+          process_directory(each)
+        end
+      end
+    end
+  end
+end

data/lib/file_scanner/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FileScanner
+  VERSION = "0.1.0"
+end

data/lib/file_scanner.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "colorize"
+require_relative "file_scanner/client"
+require_relative "file_scanner/version"
+
+module FileScanner # :nodoc:
+  # @param [String] dir Directory to be processed
+  # @param [Hash] options
+  # @option options [Boolean] :nested Specify if nested directories should be scanned
+  # @option options [String] extension Extension of filenames to be selected. Defaults to "*.mp4"
+  def self.new(dir, **options)
+    Client.new(dir, **options)
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: file_scan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- c477y
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: A utility gem which scan files recursively inside a directory and performs
+  actions with each file
+email:
+- c477y@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- lib/file_scanner.rb
+- lib/file_scanner/client.rb
+- lib/file_scanner/version.rb
+homepage: https://github.com/c477y/file_scanner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/c477y/file_scanner
+  source_code_uri: https://github.com/c477y/file_scanner
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A utility gem which scan files recursively inside a directory and performs
+  actions with each file
+test_files: []