lcsp 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3852dbd1df920676b359825fe61970b24418b2b886957226d816ec209b1a8d7
+  data.tar.gz: a6254a8de53330e26ba060dba373ef9af0a376b8bae7fc137ec8cc7e5fd4ce2d
+SHA512:
+  metadata.gz: 2c73ee05e699d93d0a9dcba80dba9332a3b7d9d43835f612d415e34e103b935a595f934a613e173a0c0cfb12344e99c695944c3e662c0b7c7d337eee6cb8c5ab
+  data.tar.gz: 13c876f4a62df38fd8acb77cdf0e3083db3508f355d2ad12d9450f698a59c23ddb476262a7c0bdd1474b57057d5a79bc7f9583f7bc85c0979c45f3149851a419

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Artem Fomchenkov
+
+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/README.md

@@ -0,0 +1,119 @@
+# lcsp
+
+[![GitHubActions](https://github.com/fartem/distincter2/workflows/Build/badge.svg)](https://github.com/fartem/distincter2/actions?branch=master)
+[![codebeat badge](https://codebeat.co/badges/eca07972-3b5a-4b3c-a424-a277ce8128b7)](https://codebeat.co/projects/github-com-fartem-lcsp-master)
+[![Gem Version](https://badge.fury.io/rb/lcsp.svg)](https://badge.fury.io/rb/lcsp)
+[![Gem Downloads](https://img.shields.io/gem/dt/lcsp)](https://badge.fury.io/rb/lcsp)
+
+## About
+
+A tool for showing solutions from LeetCode.
+
+## How to use
+
+### Installation
+
+Soon.
+
+### Run
+
+You need to provide 3 arguments for run `lcsp`:
+
+| Parameter number | Description       | Example         |
+|------------------|-------------------|-----------------|
+| 1                | GitHub user name  | `fartem`        |
+| 2                | Repository name   | `leetcode-ruby` |
+| 3                | Number of problem | `11`            |
+
+One of valid input variants be like:
+
+```shell
+$ lcsp fartem leetcode-ruby 11
+```
+
+### How to write your own `LCSPResolver`
+
+#### Read before start
+
+`lcsp` works with custom resolvers - classes that should placed in your project and that will perform
+search locally.
+
+You need to write resolver classes in Ruby because only this format accepting right now, but all work
+around search and parse for your repository you can place in classes/scripts/files in any other programming language.
+
+One of the correct and working example available
+by [this link](https://github.com/fartem/leetcode-ruby/blob/master/lcsp/finder.rb).
+
+#### Template class
+
+`path` and `number` are default parameters that are presenting for every repository. This arguments describes user needs
+and gives you parameters to search.
+
+```ruby
+# frozen_string_literal: true
+
+module LCSP
+  # Solutions finder.
+  class LCSPFinder
+    # @param {String} path
+    # @param {String} number
+    def initialize(path, number)
+      @path = path
+      @number = number
+    end
+
+    # @return {String}
+    def solution
+    end
+
+    # @param {String} path
+    # @param {String[]} dirs
+    def fill_directories(path, dirs) end
+  end
+end
+```
+
+#### Reference class example
+
+```ruby
+# frozen_string_literal: true
+
+module LCSP
+  # Solutions finder.
+  class LCSPFinder
+    # @param {String} path
+    # @param {String} number
+    def initialize(path, number)
+      @path = path
+      @number = number
+    end
+
+    # @return {String}
+    def solution
+      dirs = []
+      fill_directories(@path, dirs)
+
+      dirs.each do |directory|
+        ::Dir.foreach(directory) do |entry|
+          return "#{directory}/#{entry}" if entry.start_with?(@number)
+        end
+      end
+    end
+
+    # @param {String} path
+    # @param {String[]} dirs
+    def fill_directories(path, dirs)
+      ::Dir.foreach(path).reject { |name| name.start_with?('.') }.each do |entry|
+        unless ::File.file?("#{path}/#{entry}")
+          dirs << "#{path}/#{entry}"
+          fill_directories("#{path}/#{entry}", dirs)
+        end
+      end
+    end
+  end
+end
+```
+
+## Contributors
+
+* [@fartem](https://github.com/fartem) as Artem Fomchenkov

data/bin/lcsp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'lcsp'
+
+require_relative 'cli'

data/lib/lcsp/cache.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'git'
+
+module LCSP
+  # Base LCSP cache
+  class LCSPCache
+    # This class is responsible for managing a local cache of a specified GitHub repository.
+    # It clones the repository if it does not already exist in the cache directory.
+
+    # Initializes a new instance of LCSPCache.
+    #
+    # @param user [String] The GitHub username of the repository owner.
+    # @param repository [String] The name of the repository.
+    def initialize(user, repository)
+      @user = user
+      @repository = repository
+
+      return if exists?
+
+      ::Git.clone(
+        URI("https://github.com/#{@user}/#{@repository.downcase}"),
+        ::Pathname.new("cache_#{@user}-#{@repository.downcase}")
+      )
+    end
+
+    # Returns the path to the local cache directory for the specified repository.
+    #
+    # @return [String] The path to the local cache directory.
+    def path
+      "#{::Dir.pwd}/cache_#{@user}-#{@repository.downcase}"
+    end
+
+    private
+
+    # Checks if the local cache directory for the specified repository already exists.
+    #
+    # @return [Boolean] True if the directory exists, false otherwise.
+    def exists?
+      ::File.exist?("#{::Dir.pwd}/cache_#{@user}-#{@repository.downcase}")
+    end
+  end
+end

data/lib/lcsp/resolver.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative './cache'
+
+module LCSP
+  # LCSPResolver logic
+  class LCSPResolver
+    # LCSPResolver is responsible for resolving the Least Common Subsequence Problem (LCSP)
+    # for a given user, repository, and problem number.
+    #
+    # @param user [String] The GitHub username of the user.
+    # @param repository [String] The name of the repository containing the LCSP problem.
+    # @param number [Integer] The problem number for which the LCSP needs to be resolved.
+    def initialize(user, repository, number)
+      @user = user
+      @repository = repository
+      @number = number
+    end
+
+    # Resolves the LCSP by creating an LCSPCache instance, locating the LCSPFinder file,
+    # requiring it, and then creating an LCSPFinder instance to find the solution.
+    #
+    # @return [String] The solution to the LCSP problem.
+    # @return [nil] If the LCSPFinder file is not found or the solution is not found.
+    def resolve
+      cache = ::LCSP::LCSPCache.new(@user, @repository)
+      finder_path = "#{cache.path}/lcsp/finder.rb"
+
+      unless ::File.exist?(finder_path)
+        puts('finder.rb not found in repository. Please, check config and try again.')
+
+        exit(1)
+      end
+
+      require_relative(finder_path)
+
+      solution = ::LCSP::LCSPFinder.new(cache.path, @number).solution
+
+      if solution.nil?
+        puts('Solution not found. Please, check your input and try again.')
+
+        exit(2)
+      end
+
+      solution
+    end
+  end
+end

data/lib/lcsp.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rouge'
+require 'rouge/cli'
+
+require_relative './lcsp/resolver'
+
+module LCSP
+  # This class represents the main functionality of the LCSP (Longest Common Subsequence Problem) tool.
+  class LCSP
+    # Starts the LCSP tool by resolving the longest common subsequence for a given user, repository,
+    # and pull request number.
+    #
+    # @param user [String] The GitHub username of the repository owner.
+    # @param repository [String] The name of the GitHub repository.
+    # @param number [Integer] The pull request number.
+    #
+    # @return [Integer] The exit status of the Rouge CLI tool after processing the resolved LCSP.
+    def start(user, repository, number)
+      output = ::LCSP::LCSPResolver.new(user, repository, number).resolve
+      ::Rouge::CLI.parse([output]).run
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: lcsp
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Artem Fomchenkov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description:
+email: artem.fomchenkov@outlook.com
+executables:
+- lcsp
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/lcsp
+- lib/lcsp.rb
+- lib/lcsp/cache.rb
+- lib/lcsp/resolver.rb
+homepage: https://github.com/fartem/lcsp
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A tool for showing solutions from LeetCode
+test_files: []