did_you 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fb09003f8cd29e738be87c5fa3ca2d7fdc50076
+  data.tar.gz: 3aec1835191a0dce039885593655ac755dddf67e
+SHA512:
+  metadata.gz: f5990542239b70ddc9b6f803fd34a6acaeb7c0d7884119e98256a38ff0e272b7e7b25698f8fbc4a3914b9a5d1ea0913a8da787df2238cb4fab1061f811e7a8c9
+  data.tar.gz: 4f5f6ca86a4a8b5cfb2fc90996faca77051e9e2924843351b13e481892c24e655bc7d75d15c93ea397af57ee747c6123e74d63032202b059abe6f250a3029cb3

data/.yardopts

@@ -0,0 +1,3 @@
+--markup=markdown
+--markup-provider=kramdown
+--no-private

data/README.md

@@ -0,0 +1,43 @@
+# `DidYou::Spell` -- small wrapper around `did_you_mean`
+
+[![Gem Version](https://badge.fury.io/rb/did_you.svg)](http://badge.fury.io/rb/did_you)
+[![Build Status](https://travis-ci.org/zverok/did_you.svg?branch=master)](https://travis-ci.org/zverok/did_you)
+
+Have you seen this thing in new Ruby (2.3+)?
+
+```ruby
+(1..10).cover(2)
+# NoMethodError: undefined method `cover' for 1..10:Range
+# Did you mean?  cover?  <---- This
+```
+
+If you wanted to provide same functionality for your code ("Lexem `x` is not recognized. Did you
+mean `y`?") you can use [did_you_mean](https://github.com/yuki24/did_you_mean) gem bundled with
+your Ruby. But it is a bit hard: gem's dictionary lookup interface is a bit hard to follow, and
+moreover, it changes dramatically from Ruby 2.3 to Ruby 2.4, and standalone gem version (available
+for Ruby 2.1-2.2) has one more different interface.
+
+`did_you` solves this problem by providing simple, Ruby version-agnostic inteface to `did_you_mean`
+gem.
+
+## Usage
+
+Install it as a `gem did_you` or add `gem 'did_you'` to your `Gemfile`. (On Ruby < 2.3 it will install
+old `did_you_mean`, on newer ones has no additional dependencies.)
+
+Then just...
+
+```ruby
+# First parameter is word you want to check, second -- known words in the context
+DidYou::Spell.check('params', %w[param return tag abstract]) # => ["param"]
+```
+
+That's it. ¯\\\_(ツ)_/¯
+
+## Author
+
+[Victor Shepelev](https://github.com/zverok)
+
+## License
+
+MIT

data/did_you.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |s|
+  s.name     = 'did_you'
+  s.version  = '0.0.1'
+  s.authors  = ['Victor Shepelev']
+  s.email    = 'zverok.offline@gmail.com'
+  s.homepage = 'https://github.com/zverok/did_you'
+
+  s.summary = 'Ruby version-agnostic wrapper for did_you_mean gem'
+  s.licenses = ['MIT']
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ /^(?:
+    spec\/.*
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    |\.travis.yml
+    )$/x
+  end
+  s.require_paths = ['lib']
+
+  s.add_dependency 'did_you_mean' if RUBY_VERSION < '2.3'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'kramdown' # for YARD
+  s.add_development_dependency 'yard-junk', '>= 0.0.5'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubygems-tasks'
+end

data/lib/did_you.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+begin
+  require 'did_you_mean'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
+# Very simple "did you mean" style suggestor, wrapping different
+# versions of did_you_mean gem, both when bundled in Ruby (2.3+)
+# and not bundled (2.1-2.2).
+#
+# @example
+#
+#    DidYou::Spell.check('raise', %w[raise def class]) # => ["raise"]
+#    DidYou::Spell.check('rais', %w[raise]) # => []
+#
+# @see Spell.check
+module DidYou
+  # See {.check}
+  module Spell
+    module_function
+
+    # Checks mistyped word against provided dictionary.
+    #
+    # @param error [String] Mistyped word (say, method name).
+    # @param dictionary [Array<String>] Dictionary of known words
+    #   (say, defined methods).
+    # @return [Array<String>] List of suggested spellings or `[]`
+    #   if word is correct or did_you_mean gem is not found.
+    #
+    def check(error, dictionary)
+      _check(error, dictionary) - [error]
+    end
+
+    private
+
+    module_function
+
+    if !Kernel.const_defined?(:DidYouMean)
+      STDERR.puts 'did_you_mean gem not found.'
+      def _check(*)
+        []
+      end
+    elsif DidYouMean.const_defined?(:SpellCheckable) # 1.0 +
+      SpellChecker = Struct.new(:error, :dictionary) do
+        include DidYouMean::SpellCheckable
+
+        def candidates
+          { error => dictionary }
+        end
+      end
+
+      def _check(error, dictionary)
+        SpellChecker.new(error, dictionary).corrections
+      end
+    elsif DidYouMean.const_defined?(:SpellChecker) # 1.1+
+      def _check(error, dictionary)
+        DidYouMean::SpellChecker.new(dictionary: dictionary).correct(error)
+      end
+    elsif DidYouMean.const_defined?(:BaseFinder) # < 1.0
+      SpellFinder = Struct.new(:error, :dictionary) do
+        include DidYouMean::BaseFinder
+
+        def searches
+          { error => dictionary }
+        end
+      end
+
+      def _check(error, dictionary)
+        SpellFinder.new(error, dictionary).suggestions
+      end
+    else
+      STDERR.puts 'Unrecognized did_you_mean version. '
+      def check(*)
+        []
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: did_you
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-junk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- did_you.gemspec
+- lib/did_you.rb
+homepage: https://github.com/zverok/did_you
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Ruby version-agnostic wrapper for did_you_mean gem
+test_files: []