gem-fuzzy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9551e93e90d329a56873fc09948fdbedcbd2349541f60952f576bbce6ae04b7b
+  data.tar.gz: 57d83ddb75e77fc181ef7654cad60a37ed07db49d5610508014ce18b795bb45e
+SHA512:
+  metadata.gz: c079f4f4ad2baebc7989bc891e1ef85daf7dbd155b60d581db2dd3d5f7f3372a3271b8dce90bce8379d382e5fee32b1e4438d1f7581d7c317e5e7f8f85866382
+  data.tar.gz: 373ae90752e57ffca57a15fd17d7b6b1f8ef52099dc18cc7f3fb27e1526fe25e80e5c3a7db7fa4fce994f395ae7369fe8935c37502a1a57654b1560a78113227

data/CHANGELOG

@@ -0,0 +1,17 @@
+== 1.0.0 2019-05-14
+
+ * Command is now "gem fuzzy ...", as gem now has its own "info" command.
+ * The gem is now called gem-fuzzy to match.
+
+== 0.1.1 2011-12-28
+
+ * Silenced deprecation warnings for Rubygems 1.8.x.
+ * Fixed %dependencies for Rubygems >= 1.3.6.
+
+== 0.1.0 2011-04-09
+
+ * Support for Rubygems 1.7.
+
+== 0.0.1 2010-03-17
+
+ * Hi.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 George Ogata
+
+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,4 @@
+require 'ritual'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) { |t| t.pattern = 'test/**/*.rb' }

data/lib/gem_fuzzy.rb

@@ -0,0 +1,3 @@
+require 'gem_fuzzy/errors'
+require 'gem_fuzzy/fuzzy_matcher'
+require 'gem_fuzzy/runner'

data/lib/gem_fuzzy/errors.rb

@@ -0,0 +1,4 @@
+module GemFuzzy
+  Error = Class.new(RuntimeError)
+  UsageError = Class.new(Error)
+end

data/lib/gem_fuzzy/fuzzy_matcher.rb

@@ -0,0 +1,53 @@
+module GemFuzzy
+  class FuzzyMatcher
+    def initialize(name, version)
+      @name = name
+      @version = version
+    end
+
+    def all_available_matches
+      matches([])
+    end
+
+    def matches(specs)
+      specs = matches_for(specs, :name, @name)
+      specs = matches_for(specs, :version, @version) if @version
+      specs
+    end
+
+    def matches_for(specs, attribute, value)
+      [:exact, :substring, :subsequence].each do |type|
+        matches = send("#{type}_matches", specs, attribute, value)
+        return matches if !matches.empty?
+      end
+      []
+    end
+
+    private
+
+    def exact_matches(specs, attribute, value)
+      specs.select{|spec| spec.send(attribute).to_s == value}
+    end
+
+    def substring_matches(specs, attribute, value)
+      specs.select{|spec| spec.send(attribute).to_s.include?(value)}
+    end
+
+    def subsequence_matches(specs, attribute, value)
+      specs.select{|spec| include_subsequence?(spec.send(attribute).to_s, value)}
+    end
+
+    def include_subsequence?(string, subsequence)
+      string_index = 0
+      subsequence_index = 0
+      while string_index < string.length
+        if string[string_index] == subsequence[subsequence_index]
+          subsequence_index += 1
+          return true if subsequence_index == subsequence.length
+        end
+        string_index += 1
+      end
+      return false
+    end
+  end
+end

data/lib/gem_fuzzy/runner.rb

@@ -0,0 +1,131 @@
+module GemFuzzy
+  class Runner
+    def self.run(options, *args)
+      Runner.new(options, *args).run
+    end
+
+    def initialize(options={}, *args)
+      @options = options
+      @args = args
+      @output = STDOUT
+    end
+
+    attr_accessor :options, :args, :output
+
+    def run
+      parse_args
+      parse_options
+      matcher = FuzzyMatcher.new(@name, @version)
+      specs = matcher.matches(installed_specs)
+      validate_exactly_one(specs)
+      output_formatted(specs)
+    end
+
+    def installed_specs
+      version = Gem::Version.new(Gem::VERSION)
+      if version >= Gem::Version.new('1.8.0')
+        Gem::Specification.to_a
+      elsif version >= Gem::Version.new('1.7.0')
+        Gem.source_index.gems.values
+      else
+        Gem.source_index.all_gems.values
+      end
+    end
+
+    private
+
+    def parse_args
+      case @args.length
+      when 1
+        @name, @version = @args.first, nil
+      when 2
+        @name, @version = *@args
+      else
+        raise UsageError
+      end
+    end
+
+    def parse_options
+      @format = options[:format] || "%name %version"
+    end
+
+    def validate_exactly_one(specs)
+      if @options[:exactly_one]
+        if specs.empty?
+          raise Error, "no gems matching \"#{@name}\" \"#{@version}\""
+        elsif specs.length > 1
+          message = "#{specs.length} matching gems:\n" +
+            specs.map{|spec| "  #{spec.name}-#{spec.version}\n"}.join
+          raise Error, message
+        end
+      end
+    end
+
+    def output_formatted(specs)
+      specs.each do |spec|
+        output.print format(spec)
+        output.print "\n" unless options[:no_newlines]
+      end
+    end
+
+    def format(spec)
+      @format.gsub(format_regexp) do |match|
+        if match =~ /\A%date/
+          expand_date(spec, match)
+        else
+          self.class.expansions[match].call(spec)
+        end
+      end
+    end
+
+    def expand_date(spec, match)
+      date = spec.date
+      if match =~ /\[(.*)\]/
+        date.strftime($1)
+      else
+        date.to_s
+      end
+    end
+
+    def format_regexp
+      @format_regexp ||= Regexp.union(*self.class.expansions.keys)
+    end
+
+    class << self
+      def expand(token, &expansion)
+        @expansions ||= {}
+        expansions[token] = expansion
+      end
+      attr_reader :expansions
+    end
+
+    expand('%rubygems_version'){|spec| spec.rubygems_version}
+    expand('%specification_version'){|spec| spec.specification_version}
+    expand('%name'){|spec| spec.name}
+    expand('%version'){|spec| spec.version}
+    expand(/%date(?:\[.*?\])?/) # handled specially
+    expand('%summary'){|spec| spec.summary}
+    expand('%email'){|spec| spec.email}
+    expand('%homepage'){|spec| spec.homepage}
+    expand('%rubyforge_project'){|spec| spec.rubyforge_project}
+    expand('%description'){|spec| spec.description}
+    expand('%executables'){|spec| spec.executables.join(', ')}
+    expand('%bindir'){|spec| spec.bindir}
+    expand('%required_ruby_version'){|spec| spec.required_ruby_version}
+    expand('%required_rubygems_version'){|spec| spec.required_rubygems_version}
+    expand('%platform'){|spec| spec.platform}
+    expand('%signing_key'){|spec| spec.signing_key}
+    expand('%cert_chain'){|spec| Array(spec.cert_chain).join("\n\n")}
+    expand('%post_install_message'){|spec| spec.post_install_message}
+    expand('%authors'){|spec| spec.authors.join(', ')}
+    expand('%licenses'){|spec| spec.licenses.join(', ')}
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.3.6')
+      expand('%dependencies'){|spec| spec.dependencies.map{|dep| "#{dep.name} #{dep.requirement}"}.join(', ')}
+    else
+      expand('%dependencies'){|spec| spec.dependencies.map{|dep| "#{dep.name} #{dep.version_requirements}"}.join(', ')}
+    end
+    expand('%path'){|spec| spec.full_gem_path}
+    expand('%%'){|spec| '%'}
+    expand('%N'){|spec| "\n"}
+  end
+end

data/lib/gem_fuzzy/version.rb

@@ -0,0 +1,11 @@
+module GemFuzzy
+  VERSION = [1, 0, 0]
+
+  class << VERSION
+    include Comparable
+
+    def to_s
+      join('.')
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,130 @@
+require 'rubygems/command_manager'
+require 'gem_fuzzy'
+
+Gem::CommandManager.instance.register_command :fuzzy
+
+module Gem
+  module Commands
+    class FuzzyCommand < Command
+      def initialize
+        super 'fuzzy', "Search for gems with fuzzy matching."
+        add_option('-1', '--exactly-one', "Fail if not exactly 1 match.") do |value, options|
+          options[:exactly_one] = true
+        end
+        add_option('-f', '--format STRING', "Format of output (see below).") do |value, options|
+          options[:format] = value
+        end
+        add_option('-N', '--no-newlines', "Suppress printing of newlines after each gem") do |value, options|
+          options[:no_newlines] = true
+        end
+      end
+
+      def arguments
+        <<-EOS.gsub(/^ *\|/, '')
+          |NAME     (fuzzy) name of the gem
+          |VERSION  (fuzzy) version of the gem
+        EOS
+      end
+
+      def usage
+        "#{program_name} NAME [VERSION]"
+      end
+
+      def default_str
+        ''
+      end
+
+      def description
+        <<-EOS.gsub(/^ *\|/, '')
+          |Print information about matching gems.  The NAME and
+          |VERSION are fuzzy-matched according to the following
+          |algorithm:
+          |
+          | * Look for gems exactly matching NAME.
+          | * If none found, look for gems containing NAME. e.g.,
+          |   "fuz" matches "gem-fuzzy"
+          | * If none found, look for gems containing the characters
+          |   of NAME in the same order.  e.g, "e_zy" matches
+          |   "gem-fuzzy"
+          | * Filter the results above with the version string in the
+          |   same way.
+          |
+          |The format string (--format option) has the following
+          |escapes available:
+          |
+          |%rubygems_version
+          |  Rubygems version that built the gemspec
+          |%specification_version
+          |  Version of the gem's gemspec
+          |%name
+          |  Gem name
+          |%version
+          |  Gem version
+          |%date
+          |%date[STRFTIME_FORMAT]
+          |  Date the gem was released. STRFTIME_FORMAT may contain
+          |  any %-escapes honored by Time#strftime
+          |%summary
+          |  Summary of the gem
+          |%email
+          |  Email address of the gem author
+          |%homepage
+          |  Homepage of the gem
+          |%rubyforge_project
+          |  Name of the rubyforge project
+          |%description
+          |  Gem description
+          |%executables
+          |  List of executables (comma separated)
+          |%bindir
+          |  Directory the gem's executables are installed into
+          |%required_ruby_version
+          |  Ruby version required for the gem
+          |%required_rubygems_version
+          |  Rubygems version required for the gem
+          |%platform
+          |  Platform the gem is built for
+          |%signing_key
+          |  Key which signed the gem
+          |%cert_chain
+          |  Certificate chain used for signing ("\\n\\n" separated)
+          |%post_install_message
+          |  Message displayed upon installation
+          |%authors
+          |  List of author names (comma separated)
+          |%licenses
+          |  List of license names (comma separated)
+          |%dependencies
+          |  List of dependencies (comma separated)
+          |%path
+          |  Path of the installed gem
+          |%%
+          |  A '%' character
+          |%N
+          |  A newline
+        EOS
+      end
+
+      def execute
+        begin
+          GemFuzzy::Runner.run(options, *options[:args])
+        rescue GemFuzzy::UsageError
+          STDERR.puts "USAGE: #{usage}"
+          terminate_interaction(1)
+        rescue GemFuzzy::Error => e
+          STDERR.puts e.message
+          terminate_interaction(1)
+        rescue Object => e
+          puts "Unexpected error!  Debug with DEBUG=1"
+          if ENV['DEBUG']
+            STDERR.puts "#{exception.class}: #{exception.message}"
+            exception.backtrace.each do |line|
+              STDERR.puts "  #{line}"
+            end
+          end
+          raise
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: gem-fuzzy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- George Ogata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-14 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A Rubygems plugin which adds a 'fuzzy' command which fuzzy-searches for
+  gems and prints information about each match.
+
+  Options provide precise control over output format, making it friendly both
+  on the command line and in scripts.
+email: george.ogata@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- LICENSE
+- Rakefile
+- lib/gem_fuzzy.rb
+- lib/gem_fuzzy/errors.rb
+- lib/gem_fuzzy/fuzzy_matcher.rb
+- lib/gem_fuzzy/runner.rb
+- lib/gem_fuzzy/version.rb
+- lib/rubygems_plugin.rb
+homepage: http://github.com/oggy/gem-fuzzy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 3
+summary: Search for gems, fuzzily.
+test_files: []