magic_words 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75473fa3644dc20da4f989c704449cc84e4abb75175a833ef9bc528259016e2f
+  data.tar.gz: 11a83ddd2222390749f36a5d5f1792e9264776bdd75edf7cb6836c1dfb94a7a6
+SHA512:
+  metadata.gz: a6bf3f02b643f9be1251eb091e1737a50687b95112d440a8c9e8dc295e0c44305dfa6fdb427d6f8d98175d09e87fb58af6f6a2b8fc505d13be630f670bef414b
+  data.tar.gz: 114e4d57af83e087c3cd22e1cde727b6736303d377ae95e6f433454ec9c75bbd08ac9a15c346c17e5a05200c3fd9d6b1eea79b45edab2e87c4fd76e00bc9e2b7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in magic_words.gemspec
+gemspec
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    magic_words (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  magic_words!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aidan Coyle
+
+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,65 @@
+# MagicWords
+
+I often come across code that has been refactored by some well meaning engineers to as to avoid the usage of plain string literals. For example imagine some http request handling code.
+
+```ruby
+request.add_headers({"Content-Type" => "application/json"})
+```
+
+While this code may _appear_ simple and straightforward is is clearly in need of refactoring to avoid string literals.
+
+```ruby
+# ideally in a separate far-away file like lib/mygem/http/consts.rb
+CONTENT_TYPE = "Content-Type"
+APPLICATION_JSON = "application/json"
+
+# much easier to maintain
+request.add_headers({CONTENT_TYPE => APPLICATION_JSON})
+```
+
+However a major issue many developers run into when refactoring is the need to maintain said `const.rb` file(s) in a sufficiently indirect location. The purpose of the `magic_words` gem is to make managing such constants simple, automated, and abstract.
+
+## Usage
+
+Using `magic_words` is simple. We have some predefined dictionaries of commonly used consts, and otherwise you can add new dictionaries either by array or by file. Lets take a look at an example in practice.
+
+```ruby
+# Oh no, a "magic" string literal out in the wild!
+puts "Thou shalt not create a constant whose value can't be anything else by definition."
+
+require "magic_words"
+require "active_support/all" # for String#titleize
+
+# Load up the english dictionary
+MagicWords::Dict.from_file("english", "/usr/share/dict/words")
+
+# Much better
+puts MagicWords::Dict::ENGLISH::THOU.titleize + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::SHALT + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::NOT + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::CREATE + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::A + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::CONSTANT + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::WHOSE + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::VALUE + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::CAN + MagicWords::Punctuation::SINGLE_QUOTE + MagicWords::Letters::T + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::BE + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::ANYTHING + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::ELSE + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::BY + MagicWords::Whitespace::SPACE +
+     MagicWords::Dict::ENGLISH::DEFINITION + MagicWords::Punctuation::PERIOD
+```
+
+Couldn't be easier to avoid those pesky string literals floating around your codebase!
+
+## Contributing
+
+If you're interested in helping expand the feature set of `magic_words` please let me know. I'm currently looking for help with the following.
+
+* A tool to automatically refactor existing repos to use `magic_words`.
+* Internationalization.
+* Remedial education for developers who mindlessly apply overgeneralizations such as "avoid hard coded string literals".
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/magic_words.rb

@@ -0,0 +1,11 @@
+require "magic_words/version"
+
+require "magic_words/dict"
+require "magic_words/letters"
+require "magic_words/numerals"
+require "magic_words/punctuation"
+require "magic_words/whitespace"
+
+module MagicWords
+  EMPTY_STRING = ""
+end

data/lib/magic_words/dict.rb

@@ -0,0 +1,20 @@
+module MagicWords
+  module Dict
+    def self.from_list(name, words)
+      const_set(
+        name.upcase,
+        Module.new do
+          words.map(&:strip).each do |word|
+            next unless /^[A-Za-z]*$/.match?(word)
+
+            const_set(word.upcase, word.downcase) unless const_defined?(word.upcase)
+          end
+        end
+      )
+    end
+
+    def self.from_file(name, filename)
+      from_list(name, File.readlines(filename))
+    end
+  end
+end

data/lib/magic_words/letters.rb

@@ -0,0 +1,30 @@
+module MagicWords
+  module Letters
+    A = 'a'
+    B = 'b'
+    C = 'c'
+    D = 'd'
+    E = 'e'
+    F = 'f'
+    G = 'g'
+    H = 'h'
+    I = 'i'
+    J = 'j'
+    K = 'k'
+    L = 'l'
+    M = 'm'
+    N = 'n'
+    O = 'o'
+    P = 'p'
+    Q = 'q'
+    R = 'r'
+    S = 's'
+    T = 't'
+    U = 'u'
+    V = 'v'
+    W = 'w'
+    X = 'x'
+    Y = 'y'
+    Z = 'z'
+  end
+end

data/lib/magic_words/numerals.rb

@@ -0,0 +1,14 @@
+module MagicWords
+  module Numerals
+    ZERO = '0'
+    ONE = '1'
+    TWO = '2'
+    THREE = '3'
+    FOUR = '4'
+    FIVE = '5'
+    SIX = '6'
+    SEVEN = '7'
+    EIGHT = '8'
+    NINE = '9'
+  end
+end

data/lib/magic_words/punctuation.rb

@@ -0,0 +1,40 @@
+module MagicWords
+  module Punctuation
+    PERIOD = '.'
+    COMMA = ','
+    EXCLAMATION_POINT = '!'
+    QUESTION_MARK = '?'
+    COLON = ':'
+    SEMICOLON = ';'
+
+    TILDE = '~'
+    BACKTICK = '`'
+    AT_SIGN = '@'
+    OCTOTHORPE = '#'
+    DOLLAR_SIGN = '$'
+    PERCENT_SIGN ='%'
+    CARET = '^'
+    AMPERSAND = '&'
+    ASTERISK = '*'
+    DASH = '-'
+    UNDERSCORE = '_'
+    PLUS_SIGN = '+'
+    EQUALS_SIGN = '='
+    
+    SINGLE_QUOTE = "'"
+    DOUBLE_QUOTE = '"'
+
+    OPEN_PARENTHESIS = '('
+    CLOSE_PARENTHESIS = ')'
+    OPEN_SQUARE_BRACKET = '['
+    CLOSE_SQUARE_BRACKET = ']'
+    OPEN_CURLY_BRACKET = '{'
+    CLOSE_CURLY_BRACKEt = '}'
+    OPEN_ANGLE_BRACKET = '<'
+    CLOSE_ANGLE_BRACKET = '>'
+
+    FORWARD_SLASH = '/'
+    BACK_SLASH = '\\'
+    VERTICAL_BAR = '|'    
+  end
+end

data/lib/magic_words/version.rb

@@ -0,0 +1,3 @@
+module MagicWords
+  VERSION = "0.0.1"
+end

data/lib/magic_words/whitespace.rb

@@ -0,0 +1,7 @@
+module MagicWords
+  module Whitespace
+    SPACE = ' '
+    TAB = "\t"
+    NEWLINE = "\n"
+  end
+end

data/magic_words.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/magic_words/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magic_words"
+  spec.version       = MagicWords::VERSION
+  spec.authors       = ["Aidan Coyle"]
+  spec.email         = ["packrat386@gmail.com"]
+
+  spec.summary       = %q{avoid those messy string literals}
+  spec.homepage      = "https://github.com/packrat386/magic_words"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/packrat386/magic_words"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: magic_words
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aidan Coyle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- packrat386@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/magic_words.rb
+- lib/magic_words/dict.rb
+- lib/magic_words/letters.rb
+- lib/magic_words/numerals.rb
+- lib/magic_words/punctuation.rb
+- lib/magic_words/version.rb
+- lib/magic_words/whitespace.rb
+- magic_words.gemspec
+homepage: https://github.com/packrat386/magic_words
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/packrat386/magic_words
+  source_code_uri: https://github.com/packrat386/magic_words
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: avoid those messy string literals
+test_files: []