screenscrot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc37a5ede10e26e8da5d5cceba93a4b2d15a15d9ccfae80bd7ad363e300a9a22
+  data.tar.gz: d512bd19e7dc9820084cf1615410639e150240af95a7489f5c1dd3bd0f459f6f
+SHA512:
+  metadata.gz: bdbf0d667085956c51e4d27d5df623c4f1041d72d4fa2472af04187a9b8c76d73db7a8b06886d2940af54bb51dc5e7c2d3d3f643edb5974085703e1d8c0e4345
+  data.tar.gz: f94a5a1e69b16c1870c88b4cc3ede26077e3bd2be9b0b1f9c2d67187c513ee6a7b31e10f61725dee210cb23c616694340f652b3a7f843b9f3c722e996c5fc73a

data/bin/screenscrot

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/screenscrot'
+
+puts 'Start Recording Screenshots...'
+
+ScreenScrot.setup do |screen|
+  screen.title = ARGV[1] || 'ScreenScrot'
+  screen.ext = 'png'
+  screen.path = Dir.pwd
+end
+
+@screen = ScreenScrot.new(ScreenScrot.title)
+
+system 'clear'
+
+cnt = 5
+cnt.times do
+  puts "Starting in #{cnt -= 1}"
+  sleep 1
+  system 'clear'
+end
+
+puts '[Screenshot Recording Started]'
+
+str_time = Time.now
+max_time = ARGV[0].to_i unless ARGV.empty?
+
+display = ARGV.include?('--all') ? :all : :active
+display = '--select' if ARGV.include?('--select')
+
+until (Time.now - str_time).to_i >= max_time
+  @screen.capture(display)
+  sleep 0.5
+end
+
+print '[Screenshot Recording Stopped] after '
+puts  "#{(Time.now - str_time).to_f.round(2)} seconds"
+puts  "Captured frames -> [#{@screen.frames}]"
+puts ' > making GIF animation...'
+
+@screen.to_gif
+
+print "[GIF CREATED!] - File saved as #{@screen.title}.gif in #{@screen.directory}"
+puts

data/lib/screenscrot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ScreenScrot
+  VERSION = '0.1.0'
+end

data/lib/screenscrot.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative 'screenscrot/version'
+
+##
+# Capture screenshots with SCROT and create .gif animation
+#
+class ScreenScrot
+  attr_accessor :title, :ext, :path, :directory, :frames
+
+  alias extension ext
+  alias dir directory
+
+  ##
+  # Set default configuration for title, image extension and path directory.
+  #
+  class << self
+    attr_accessor :title, :path, :ext
+
+    def configure
+      init
+      yield(ScreenScrot) if block_given?
+      return true if title && path && ext
+
+      false
+    end
+
+    alias config configure
+    alias setup configure
+
+    private
+
+    def init
+      @title ||= 'ScreenScrot'
+      @path ||= Dir.pwd
+      @ext ||= 'png'
+      true
+    end
+  end
+
+  ##
+  # @example
+  #   screen = ScreenScrot.new 'title', 'path_to_dir', 'image_extension'
+  # @return [ScreenScrot] ScreenScrot instance object.
+  #
+  def initialize(title = nil, path = nil, ext = nil)
+    ScreenScrot.configure
+    @frames = 0
+    @title = title || ScreenScrot.title
+    @path = path || ScreenScrot.path
+    @ext = ext || ScreenScrot.ext
+    [@title, @path, @ext].select do |type|
+      raise 'Configuration data must be string!' unless type.is_a?(String)
+    end
+    @path += '/' unless @path.end_with?('/')
+    @filename = "#{@title}_#{rand(999)}"
+    @directory =  "#{@path}#{@filename}/"
+    system "mkdir -p #{@directory}" unless Dir.exist?(@directory)
+    Dir.chdir(@directory)
+  end
+
+  ##
+  # Capture screenshot with `SCROT`
+  #
+  # @example Capture active window (default)
+  #   screen.capture
+  #
+  # @example Capture all screen
+  #   screen.capture :all
+  #
+  # @example Capture selected with mouse
+  #   screen.capture :select
+  #
+  def capture(win = :active, quality: 75)
+    scr = case win.to_sym
+          when :all
+            ''    # rec everything
+          when :select
+            '-s'  # select with mouse
+          else
+            '-u' # active window (default)
+          end
+    screenshot = @directory + Time.now.to_f.to_s.gsub!('.', '')
+    exec = "scrot #{scr} -q #{quality} #{screenshot + @frames.to_s}.#{@ext}"
+    system exec
+    # captured frames counter
+    @frames += 1
+  end
+
+  def to_gif(title = nil, opts = {})
+    title ||= @filename
+    opts[:dir]   ||= @directory
+    opts[:ext]   ||= @ext
+    opts[:delay] ||= 20
+    opts[:loop]  ||= 2
+    Dir.chdir(opts[:dir])
+    title += '.gif' unless title.end_with? '.gif'
+    exec = "convert -delay #{opts[:delay]} -loop #{opts[:loop]} *.#{opts[:ext]} #{title}"
+    system exec
+  rescue StandardError
+    false
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: screenscrot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alx3Dev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: |
+  Get screenshots with Scrot, and convert into GIF. Simple terminal
+  recording with Ruby and Scrot.
+email: alx3dev@gmail.com
+executables:
+- screenscrot
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/screenscrot
+- lib/screenscrot.rb
+- lib/screenscrot/version.rb
+homepage: https://www.github.com/alx3dev/screenscrot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/alx3dev/screenscrot
+  source_code_uri: https://www.github.com/alx3dev/screenscrot
+  changelog_uri: https://www.github.com/alx3dev/screenscrot/CHANGELOG.md
+  documentation_uri: https://rubygems.info/gems/screenscrot/0.1.0
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.6
+signing_key:
+specification_version: 4
+summary: Terminal to GIF recording with Ruby and Scrot.
+test_files: []