lcsp 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3852dbd1df920676b359825fe61970b24418b2b886957226d816ec209b1a8d7
-  data.tar.gz: a6254a8de53330e26ba060dba373ef9af0a376b8bae7fc137ec8cc7e5fd4ce2d
+  metadata.gz: 16e91d0da69256bc676adfc9781e20d13ab9e8838de68624be502a6b86aebfb6
+  data.tar.gz: bfa5f3b8fb5bd4b895962680698d5c53312406377d92ced04a7af541a7baf66b
 SHA512:
-  metadata.gz: 2c73ee05e699d93d0a9dcba80dba9332a3b7d9d43835f612d415e34e103b935a595f934a613e173a0c0cfb12344e99c695944c3e662c0b7c7d337eee6cb8c5ab
-  data.tar.gz: 13c876f4a62df38fd8acb77cdf0e3083db3508f355d2ad12d9450f698a59c23ddb476262a7c0bdd1474b57057d5a79bc7f9583f7bc85c0979c45f3149851a419
+  metadata.gz: 16a986eda1844a8be0a2322faf352aa69ed376e2fb05b35e2baf454e4df2798f73b4cf68607f9dc0d1a6c868a8751ab20b33cdfbf8fe423b7dbd68c2a8872ccf
+  data.tar.gz: b28f8f08681cbda9244f9fbb2ad4b35ee52e1a69c4a1f43c8901cb8a50abce0b4ca4a2333455778b39835322ec7b96d316711737f3d8639019bd6da73291007e

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Artem Fomchenkov
+Copyright (c) 2023-2025 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

data/README.md

@@ -1,44 +1,96 @@
 # lcsp
 
-[![GitHubActions](https://github.com/fartem/distincter2/workflows/Build/badge.svg)](https://github.com/fartem/distincter2/actions?branch=master)
+[![GitHubActions](https://github.com/fartem/lcsp/workflows/Build/badge.svg)](https://github.com/fartem/lcsp/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.
+A tool for showing and counting solutions from LeetCode.
 
 ## How to use
 
 ### Installation
 
-Soon.
+#### Download gem from RubyGems
 
-### Run
+```shell
+$ gem i lcsp
+```
+
+#### As local installed gem
+
+Build and install gem from sources:
+
+```shell
+$ gem build lcsp.gemspec
+$ gem i lcsp
+```
+
+### Print solution
 
-You need to provide 3 arguments for run `lcsp`:
+You need to provide 3 arguments for run `print` command:
 
-| Parameter number | Description       | Example         |
-|------------------|-------------------|-----------------|
-| 1                | GitHub user name  | `fartem`        |
-| 2                | Repository name   | `leetcode-ruby` |
-| 3                | Number of problem | `11`            |
+| Parameter | Description       | Example         |
+| --------- | ----------------- | --------------- |
+| `user`    | GitHub user name  | `fartem`        |
+| `repo`    | Repository name   | `leetcode-ruby` |
+| `number`  | Number of problem | `11`            |
 
 One of valid input variants be like:
 
 ```shell
-$ lcsp fartem leetcode-ruby 11
+$ lcsp print --user=fartem --repo=leetcode-ruby --number=11
+```
+
+### Count solutions
+
+You need to provide 2 arguments for run `count` command:
+
+| Parameter | Description      | Example         |
+| --------- | ---------------- | --------------- |
+| `user`    | GitHub user name | `fartem`        |
+| `repo`    | Repository name  | `leetcode-ruby` |
+
+One of valid input variants be like:
+
+```shell
+$ lcsp count --user=fartem --repo=leetcode-ruby
+```
+
+### Clean local cache
+
+Just run next command from any folder:
+
+```shell
+$ lcsp clean
+```
+
+### Contacts
+
+You can see actual author contacts by following command:
+
+```shell
+$ lcsp author
 ```
 
-### How to write your own `LCSPResolver`
+### Version
+
+If you need to check installed version of `lcsp`, run from shell:
+
+```shell
+$ lcsp author
+```
+
+### How to write your own `LCSPFinder`
 
 #### Read before start
 
-`lcsp` works with custom resolvers - classes that should placed in your project and that will perform
+`lcsp` works with custom finders - 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
+You need to write finder 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
@@ -65,10 +117,6 @@ module LCSP
     # @return {String}
     def solution
     end
-
-    # @param {String} path
-    # @param {String[]} dirs
-    def fill_directories(path, dirs) end
   end
 end
 ```
@@ -114,6 +162,75 @@ module LCSP
 end
 ```
 
+### How to write your own `LCSCCounter`
+
+#### Read before start
+
+`lcsc` works with custom counters - classes that should placed in your project and that will perform
+count locally.
+
+You need to write counter 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/counter.rb).
+
+#### Template class
+
+`path` are default parameter that are presenting for every repository. It is a path to repository in cache.
+
+```ruby
+# frozen_string_literal: true
+
+require 'find'
+
+module LCSC
+  # Solutions counter.
+  class LCSCCounter
+    # @param {String} path
+    def initialize
+      @path = './'
+    end
+
+    # @return {Integer}
+    def count
+      dir_sub = "#{@path}/lib"
+
+      easy = find_for_dir("#{dir_sub}/easy")
+      medium = find_for_dir("#{dir_sub}/medium")
+
+      easy + medium
+    end
+
+    private
+
+    def find_for_dir(dir)
+      ::Find.find(dir).count { |file| ::File.file?(file) }
+    end
+  end
+end
+```
+
+#### Reference class example
+
+```ruby
+# frozen_string_literal: true
+
+module LCSC
+  # Solutions counter.
+  class LCSCFinder
+    # @param {String} path
+    def initialize(path)
+      @path = path
+    end
+
+    # @return {Integer}
+    def count
+    end
+  end
+end
+```
+
 ## Contributors
 
 * [@fartem](https://github.com/fartem) as Artem Fomchenkov

data/bin/cli.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'fileutils'
+require 'rubygems'
+
+module CLI
+  # lcsp CLI
+  module Commands
+    extend Dry::CLI::Registry
+
+    # This class represents a command for printing a solution.
+    # It inherits from Dry::CLI::Command and is registered under the 'print' alias.
+    class Print < ::Dry::CLI::Command
+      # Description of the command.
+      desc 'Prints solution'
+
+      # Option definition for the GitHub user name.
+      # Default value is an empty string.
+      option :user,
+             default: '',
+             desc: 'GitHub user name'
+
+      # Option definition for the GitHub repository with solutions.
+      # Default value is an empty string.
+      option :repo,
+             default: '',
+             desc: 'GitHub repository with solutions'
+
+      # Option definition for the number of needed solution.
+      # Default value is an empty string.
+      option :number,
+             default: '',
+             desc: 'Number of needed solution'
+
+      # The main method of the command.
+      # It creates an instance of LCSP::LCSP and calls its start method with the provided options.
+      #
+      # @param options [Hash] The command-line options.
+      # @option options [String] :user The GitHub user name.
+      # @option options [String] :repo The GitHub repository with solutions.
+      # @option options [String] :number The number of needed solution.
+      #
+      # @return [void]
+      def call(options)
+        ::LCSP::LCSP.new.start(
+          options[:user],
+          options[:repo],
+          options[:number]
+        )
+      end
+    end
+
+    # This class represents a command for counting solutions.
+    # It inherits from Dry::CLI::Command and is registered under the 'count' alias.
+    class Count < ::Dry::CLI::Command
+      desc 'Counts solutions'
+
+      option :user,
+             default: '',
+             desc: 'GitHub user name'
+
+      option :repo,
+             default: '',
+             desc: 'GitHub repository with solutions'
+
+      # The main method of the command.
+      # It creates an instance of LCSC::LCSC and calls its start method with the provided options.
+      #
+      # @param options [Hash] The command-line options.
+      # @option options [String] :user The GitHub user name.
+      # @option options [String] :repo The GitHub repository with solutions.
+      #
+      # @return [void]
+      def call(options)
+        ::LCSC::LCSC.new.start(
+          options[:user],
+          options[:repo],
+          options[:number]
+        )
+      end
+    end
+
+    # This class represents a command for cleaning the local cache of LCSP.
+    # It inherits from Dry::CLI::Command and is registered under the 'clean' alias.
+    class Clean < ::Dry::CLI::Command
+      # Description of the command.
+      desc 'Clean lscp cache'
+
+      # The main method of the command.
+      # It removes all folders in the current directory that start with 'cache_'.
+      #
+      # @return [void]
+      def call
+        # Get all entries in the current directory.
+        folders = ::Dir.entries('.').select { |entry| entry.include?('cache_') }
+
+        # Iterate over the selected folders and remove them.
+        folders.each { |folder| ::FileUtils.rm_rf(folder) }
+      end
+    end
+
+    # This class represents a command for printing the version of LCSP.
+    # It inherits from Dry::CLI::Command and is registered under the 'version' alias.
+    class Version < ::Dry::CLI::Command
+      # Description of the command.
+      desc 'Prints using version of lcsp'
+
+      # The main method of the command.
+      # It retrieves the version of the lcsp gem from its gemspec file and prints it.
+      #
+      # @return [void]
+      def call
+        # Load the lcsp gem specification.
+        spec = ::Gem::Specification.load('lcsp.gemspec')
+
+        # Print the version of the lcsp gem.
+        puts(spec.version)
+      end
+    end
+
+    # This class represents a command for printing the author of LCSP.
+    # It inherits from Dry::CLI::Command and is registered under the 'author' alias.
+    class Author < ::Dry::CLI::Command
+      # Description of the command.
+      desc 'Prints the author of lcsp'
+
+      # The main method of the command.
+      # It retrieves the author, email, and homepage information of the lcsp gem from its gemspec file and prints it.
+      #
+      # @return [void]
+      def call
+        # Load the lcsp gem specification.
+        spec = ::Gem::Specification.load('lcsp.gemspec')
+
+        # Print the author(s) of the lcsp gem.
+        puts("Authors: #{spec.authors.join(', ').strip}")
+
+        # Print the email(s) of the lcsp gem author(s).
+        puts("Email: #{spec.email}")
+
+        # Print the homepage of the lcsp gem.
+        puts("Homepage: #{spec.homepage}")
+      end
+    end
+
+    register 'print', Print.new, aliases: ['p']
+    register 'count', Count.new, aliases: ['t']
+    register 'clean', Clean.new, aliases: ['c']
+    register 'version', Version.new, aliases: ['v']
+    register 'author', Author.new, aliases: ['a']
+  end
+end
+
+::Dry::CLI.new(::CLI::Commands).call

data/lib/lcsc/resolver.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../common/cache'
+
+module LCSC
+  # LCSCResolver logic.
+  class LCSCResolver
+    # LCSCResolver is entry point for any LCSP request by user.
+    #
+    # @param user [String] The GitHub username of the user.
+    # @param repository [String] The name of the repository containing the LCSP problem.
+    def initialize(user, repository)
+      @user = user
+      @repository = repository
+    end
+
+    # Resolves the LCSC by creating an LCSPCache instance, locating the LCSCCounter file,
+    # requiring it, and then creating an LCSCCounter 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/counter.rb"
+
+      unless ::File.exist?(finder_path)
+        puts('counter.rb not found in repository. Please, check config and try again.')
+
+        exit(1)
+      end
+
+      require_relative(finder_path)
+
+      count = ::LCSC::LCSCCounter.new(cache.path).count
+
+      if count.nil?
+        puts('Failed to count solutions. Please, check your input and try again.')
+
+        exit(2)
+      end
+
+      count
+    end
+  end
+end

data/lib/lcsc.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rouge'
+require 'rouge/cli'
+
+require_relative './lcsc/resolver'
+
+module LCSC
+  # This class represents the main functionality of the LCSC (LeetCode Solution Counter) tool.
+  class LCSC
+    # Starts the LCSC tool.
+    #
+    # @param user [String] The GitHub username of the repository owner.
+    # @param repository [String] The name of the GitHub repository.
+    #
+    # @return [Integer] The exit status of the Rouge CLI tool after processing the resolved LCSP.
+    def start(user, repository)
+      output = ::LCSC::LCSCResolver.new(user, repository).resolve
+
+      ::Rouge::CLI.parse([output]).run
+    end
+  end
+end

data/lib/lcsp/resolver.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require_relative './cache'
+require_relative '../common/cache'
 
 module LCSP
-  # LCSPResolver logic
+  # LCSPResolver logic.
   class LCSPResolver
-    # LCSPResolver is responsible for resolving the Least Common Subsequence Problem (LCSP)
-    # for a given user, repository, and problem number.
+    # LCSPResolver is entry point for any LCSP request by user.
     #
     # @param user [String] The GitHub username of the user.
     # @param repository [String] The name of the repository containing the LCSP problem.

data/lib/lcsp.rb

@@ -6,10 +6,9 @@ require 'rouge/cli'
 require_relative './lcsp/resolver'
 
 module LCSP
-  # This class represents the main functionality of the LCSP (Longest Common Subsequence Problem) tool.
+  # This class represents the main functionality of the LCSP (LeetCode Solution Printer) tool.
   class LCSP
-    # Starts the LCSP tool by resolving the longest common subsequence for a given user, repository,
-    # and pull request number.
+    # Starts the LCSP tool.
     #
     # @param user [String] The GitHub username of the repository owner.
     # @param repository [String] The name of the GitHub repository.
@@ -18,6 +17,7 @@ module LCSP
     # @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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lcsp
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-20 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -132,9 +132,12 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
+- bin/cli.rb
 - bin/lcsp
+- lib/common/cache.rb
+- lib/lcsc.rb
+- lib/lcsc/resolver.rb
 - lib/lcsp.rb
-- lib/lcsp/cache.rb
 - lib/lcsp/resolver.rb
 homepage: https://github.com/fartem/lcsp
 licenses:
@@ -156,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A tool for showing solutions from LeetCode