spellr 0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dana Sherson
+
+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,64 @@
+# Spellr
+
+Spell check your source code for fun and occasionally finding bugs
+
+This is inspired by https://github.com/myint/scspell but i wanted a ruby gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spellr', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spellr
+
+## Usage
+
+To start an interactive spell checking session
+```
+spellr --interactive
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/robotdana/spellr.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TODO Before release
+
+- [x] handle interactive add
+  - [x] handling wordlists per language better
+      - [x] global wordlists
+      - [x] dynamic wordlist (e.g. built from ruby and YOUR Gemfile and stdlib packages)
+      - [x] gem committed semi-dynamic wordlist
+      - [x] gem committed static wordlist
+- [x] enable/disable
+- [x] get marketplacer codebase green
+- [x] escape
+- [ ] remove default dynamic wordlist nonsense
+- [x] fix bugs, have specs
+- [x] attempt key recognition
+## TODO after release
+- [ ] throw instead of raise for flow control
+- [ ] attempt subwords again
+- [ ] (semi)dynamic js wordlist
+- [ ] (semi)dynamic html wordlist
+- [ ] (semi)dynamic bash wordlist
+- [ ] editor plugins

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'spellr'
+require 'pry'
+
+Pry.start

data/bin/fetch_wordlist/english

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'net/http'
+require 'optparse'
+
+class SCOWLDownloader
+  SIZE_OPTIONS = %w{10 20 35 40 50 55 60 70 80 95}.freeze
+  VARIANT_OPTIONS = %w{none common acceptable seldom-used}.freeze
+  DIACRITIC_OPTIONS = %w{strip keep both}.freeze
+  SPELLING_LANGUAGE_OPTIONS = %w{US GBs GBz CA AU}.freeze
+
+  def initialize
+    set_default_options
+    parse_options
+    puts Net::HTTP.get_response(uri).body
+  end
+
+  private
+
+  def set_default_options
+    @options = {
+      max_size: 50,
+      spelling: :US,
+      max_variant: 0,
+      diacritic: :both,
+      hacker: true
+    }
+  end
+
+  def parse_options # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/LineLength
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: spellr [options] fetch english [wordlist options]'
+      opts.on('-s', '--max-size', '=SIZE', String, SIZE_OPTIONS, 'Wordlist size. Options: 10 (~5,000 words), 20, 35, 40, 50 (default), 60, 70 (~170,000 words)') { |i| @options[:max_size] = i }
+      opts.on('-v', '--max-variants', '=VARIANTS', String, VARIANT_OPTIONS, 'Spelling variants. Options: none (default), common, acceptable, seldom-used') { |i| @options[:max_variant] = VARIANT_OPTIONS.index(i) }
+      opts.on('-d', '--diacritic', '=DIACRITIC', String, DIACRITIC_OPTIONS, 'Include diacritics in words. Options: strip (café becomes cafe), keep, both (default. cafe & café)') { |s| @options[:diacritic] = s }
+      opts.on('-l', '--language=x,y,z', Array, 'Comma separated list of English variations. Options: US (default), GBs (GB with -ise), GBz (GB with -ize), CA, AU') do |a|
+        raise ArgumentError unless (a - SPELLING_LANGUAGE_OPTIONS).empty?
+
+        @options[:spelling] = a
+      end
+      opts.on('-p', '--[no-]programming', 'include common programming terms like grep (default true)') { |h| @options[:special] = :hacker if h }
+      opts.on_tail('-h', '--help') do
+        warn opts.to_s
+        exit 1
+      end
+    end.parse!
+    # rubocop:enable Metrics/LineLength
+  end
+
+  attr_reader :options
+
+  def uri
+    query = URI.encode_www_form(
+      **options,
+      download: :wordlist,
+      encoding: :'utf-8',
+      format: :inline
+    )
+    URI.parse("http://app.aspell.net/create?#{query}")
+  end
+end
+
+SCOWLDownloader.new

data/bin/fetch_wordlist/ruby

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+class RubyWords # rubocop:disable Metrics/ClassLength
+  def initialize
+    @strings = []
+    prepare_excluded_classes
+
+    parse_options
+
+    prepare_post_excluded_classes
+
+    puts generate_words
+  end
+
+  private
+
+  def prepare_excluded_classes
+    @looked_at = []
+    @looked_at << RubyWords.__id__
+    @looked_at << OptionParser.__id__ # because we're including it here
+  end
+
+  def generate_words
+    $VERBOSE = nil
+    @strings = []
+    generate_words_for(Module)
+    generate_keywords
+    generate_convention_words
+  end
+
+  def generate_words_for(constant)
+    return if @looked_at.include?(constant.__id__) # to prevent endless loops
+
+    @looked_at << constant.__id__
+
+    generate_methods_for(constant)
+    generate_child_constants_for(constant)
+  end
+
+  def generate_methods_for(constant)
+    @strings |= constant.public_instance_methods(false) if constant.respond_to?(:public_instance_methods)
+    @strings |= constant.public_methods(false) if constant.respond_to?(:public_methods)
+  end
+
+  def generate_child_constants_for(constant) # rubocop:disable Metrics/MethodLength
+    return unless constant.respond_to?(:constants)
+
+    constant.constants.each do |child|
+      if autoload?(child)
+        warn "Skipping autoload constant #{constant}::#{child}"
+        next
+      end
+
+      @strings |= [child]
+      child = constant.const_get(child)
+      generate_words_for(child)
+    rescue StandardError, LoadError => e
+      warn "Error loading #{constant}::#{child} => #{e.message}"
+    end
+  end
+
+  def generate_keywords
+    @strings |= %w{
+      __ENCODING__ __LINE__ __FILE__ BEGIN END alias and begin break case class def
+      defined? do else elsif end ensure false for if in module next nil not or redo
+      rescue retry return self super then true undef unless until when while yield
+    }
+  end
+
+  def generate_convention_words
+    @strings |= %w{
+      klass
+    }
+  end
+
+  # badly behaved classes that I'll always have to exclude
+  # TODO: use the full class name rather than __id__ so i don't have to load anything
+  def prepare_post_excluded_classes
+    %w{RSpec::Core::Runner I18n::Tests}.each do |exclude|
+      @looked_at << Module.const_get(exclude).__id__
+    rescue StandardError, LoadError # rubocop:disable Lint/HandleExceptions
+    end
+  end
+
+  def exclude_option(excludes, quiet: false)
+    excludes.each do |exclude|
+      @looked_at << Module.const_get(exclude).__id__
+    rescue StandardError, LoadError => e
+      warn "Error excluding #{exclude} => #{e.message}" unless quiet
+    end
+  end
+
+  def bundler_option(_)
+    require 'bundler/setup'
+    require_each Bundler.setup.requires.values.flatten(1)
+  end
+
+  def require_each(requirables)
+    requirables.each(&method(:soft_require))
+  end
+
+  def soft_require(requireable)
+    require requireable
+  rescue LoadError => e
+    warn "Error requiring #{requireable} => #{e.message}"
+  end
+
+  def require_option(gems)
+    soft_require 'bundler/setup'
+    require_each(gems)
+  end
+
+  def available_stdlibs
+    %w{
+      abbrev base64 benchmark bigdecimal cgi cmath coverage csv date delegate digest
+      drb/drb e2mmap English erb etc expect fcntl fiddle fileutils find forwardable
+      getoptlong io/console io/nonblock io/wait ipaddr irb json logger matrix mkmf
+      monitor mutex_m net/ftp net/http net/imap net/pop net/smtp net/telnet nkf
+      objspace observer open-uri open3 openssl optionparser optparse ostruct pathname
+      pp prettyprint prime pstore psych pty racc/parser readline resolv ripper rss scanf
+      sdbm securerandom set shell shellwords singleton socket stringio strscan sync syslog
+      tempfile thwait time timeout tmpdir tracer tsort uri weakref webrick yaml zlib
+    }
+  end
+
+  def stdlib_option(stdlibs)
+    stdlibs &= available_stdlibs
+    stdlibs.each { |p| require p }
+    @strings += stdlibs
+    @looked_at -= [OptionParser.__id__] if stdlibs.include?('optparse') # because they might want it too
+  end
+
+  def parse_options # rubocop:disable Metrics/MethodLength
+    OptionParser.new do |opts|
+      opts.set_program_name 'spellr --fetch ruby'
+      opts.on('-r', '--require=x,y,z', Array, 'requires the specified gems', &method(:require_option))
+      opts.on('-s', '--stdlib=x,y,z', Array, 'requires the specified stdlib packages', &method(:stdlib_option))
+      opts.on('-b', '--bundler', 'includes methods and constants required by emfile', &method(:bundler_option))
+      opts.on('-x', '--exclude=x,y,z', Array, 'exclude listing these constants and their methods', &method(:exclude_option)) # rubocop:disable Metrics/LineLength
+      opts.on_tail('-h', '--help', 'Shows this message') do
+        warn opts
+        exit 1
+      end
+    end.parse!
+  end
+end
+
+RubyWords.new

data/bin/setup

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle install

data/exe/spellr

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/spellr/cli'
+Spellr::CLI.new(ARGV)

data/lib/.spellr.yml

@@ -0,0 +1,93 @@
+---
+word_minimum_length: 3
+
+ignore: # this list is parsed with the .gitignore format
+  - /.git/
+  - .DS_Store
+  - Gemfile.lock
+  - .rspec_status
+  - '*.png'
+  - '*.jpg'
+  - '*.gif'
+  - '*.ico'
+  - .gitkeep
+  - .keep
+  - '*.svg'
+  - '*.eot'
+  - '*.ttf'
+  - '*.woff'
+  - '*.woff2'
+  - '*.zip'
+  - '*.pdf'
+  - '*.xlsx'
+  - '*.gz'
+
+languages:
+  english:
+    generate: "fetch english"
+    # TODO: don't generate the ruby file until you actually need one
+  ruby:
+    only: # Filtered using File.fn_match
+      - '*.rb'
+      - '*.rake'
+      - '*.gemspec'
+      - '*.erb'
+      - '*.haml'
+      - '*.jbuilder'
+      - '*.builder'
+      - Gemfile
+      - Rakefile
+      - config.ru
+    hashbangs:
+      - ruby
+  html:
+    only:
+      - '*.html'
+      - '*.hml'
+      - '*.jsx'
+      - '*.tsx'
+      - '*.js'
+      - '*.ts'
+      - '*.coffee'
+      - '*.haml'
+      - '*.erb'
+      - '*.rb'
+      - '*.builder'
+      - '*.css'
+      - '*.scss'
+      - '*.sass'
+      - '*.less'
+  js:
+    only:
+      - '*.html'
+      - '*.hml'
+      - '*.jsx'
+      - '*.tsx'
+      - '*.js'
+      - '*.ts'
+      - '*.coffee'
+      - '*.haml'
+      - '*.erb'
+      - '*.json'
+  shell:
+    only:
+      - '*.sh'
+      - Dockerfile
+    hashbangs:
+      - bash
+      - sh
+  dockerfile:
+    only:
+      - Dockerfile
+  css:
+    only:
+      - '*.css'
+      - '*.sass'
+      - '*.scss'
+  xml:
+    only:
+      - '*.xml'
+      - '*.html'
+      - '*.haml'
+      - '*.hml'
+      - '*.svg'

data/lib/spellr.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Spellr
+  class Error < StandardError; end
+  class DidReplacement < Spellr::Error
+    attr_reader :token
+
+    def initialize(token = nil)
+      @token = token
+    end
+  end
+  class DidAdd < Spellr::Error
+    attr_reader :token
+
+    def initialize(token = nil)
+      @token = token
+    end
+  end
+
+  module_function
+
+  def config
+    require_relative 'spellr/config'
+    @config ||= Spellr::Config.new
+  end
+end