simple_symbolize 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00aee90791b358af5b1a734d538f40bdd1a200b59888ca23efd18b1ceb40593a
+  data.tar.gz: a7e7e1087d2becd6181bf87243e823ce361dd8b40b3b25d04265ba589b6b4637
+SHA512:
+  metadata.gz: 8f44009fa310ff0c0ad1595b5ece9f99c64168f3ca4bf5c4d50bce8edd198507d6761fe577894891aab26fbedb30e2d78bbcfcc9405ac6334c45060325d1cd09
+  data.tar.gz: 4468a0ebbe074887e985416a9c8abda90d688290c62d3c3e0faef0bd8ccddf52851848e896e57ed5835d05d9146cfe15852df6c285b47ea1c59e444afe4f6a57

data/.drone.yml

@@ -0,0 +1,32 @@
+---
+kind: pipeline
+name: default
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+  - name: unit tests
+    pull: if-not-exists
+    image: ecr.tooling.dvla.gov.uk/base-images/qe-ruby:2.7.0-1
+    commands:
+      - bundle --jobs 5 --quiet
+      - bundle exec rspec
+    when:
+      event:
+        - push
+
+  - name: build and deploy
+    pull: if-not-exists
+    image: ecr.tooling.dvla.gov.uk/base-images/qe-ruby:2.7.0-1
+    commands:
+      - apk add --update git unzip alpine-sdk jq --no-cache
+      - gem install bundler
+      - gem install nexus
+      - bundle --jobs 5 --quiet
+      - gem build simple_symbolize.gemspec
+      - gem nexus --url https://nexus.tooling.dvla.gov.uk/repository/gem-private/ simple_symbolize*gem
+    when:
+      branch:
+        - master

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false

data/.rubocop_todo.yml

@@ -0,0 +1,67 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-06-29 14:23:53 UTC using RuboCop version 1.18.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/simple_symbolize.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 88
+
+# Offense count: 3
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/simple_symbolize/translations.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/simple_symbolize.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'lib/simple_symbolize.rb'
+    - 'lib/simple_symbolize/string.rb'
+    - 'lib/simple_symbolize/translations.rb'
+    - 'lib/simple_symbolize/version.rb'
+    - 'simple_symbolize.gemspec'
+    - 'spec/simple_symbolize_spec.rb'
+    - 'spec/spec_helper.rb'
+
+Style/MixinUsage:
+  Exclude:
+    - 'lib/simple_symbolize.rb'
+
+
+
+
+
+
+
+
+
+
+

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_symbolize.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    simple_symbolize (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.18.0)
+  simple_symbolize!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 DVLA
+
+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,80 @@
+# SimpleSymbolize
+
+SimpleSymbolize takes a string and transforms it into a symbol. Why? Because working with symbols in Ruby makes for a 
+good time.
+
+Wait, doesn't String already have a `to_sym` method?
+
+Correct! However, this gem takes it one step further by transforming special characters and whitespace to give you a 
+simple easy to work with Symbol.
+
+It works by transforming special characters in a String like `'!'` into underscores and removing whitespace.
+
+#### Example
+
+```ruby
+# to_sym
+'hello world!'.to_sym # => :"hello world!"
+
+# Symbolize gem
+'hello world!'.symbolize # => :hello_world
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_symbolize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_symbolize
+
+## Usage
+
+There are two ways to symbolize your String.
+
+### Call the symbolize method and pass it your String
+
+```ruby
+require 'simple_symbolize'
+
+SimpleSymbolize.symbolize('hello world!') # => :hello_world
+```
+
+### Call the symbolize method on your String object
+
+```ruby
+require 'simple_symbolize'
+
+'hello world!'.symbolize # => :hello_world
+```
+
+## Configuration
+
+Something not underscored or removed? Or even something underscored/removed that you didn't want transformed? 
+
+No sweat, you can configure this gem to underscore and remove to your hearts content!
+
+```ruby
+SimpleSymbolize.translate do |trans|
+  trans.to_underscore('!')
+  trans.to_remove(' ')
+  trans.to_omit('@')
+end
+```
+
+[comment]: <> (## Contributing)
+
+[comment]: <> (Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_symbolize.)
+
+
+[comment]: <> (## License)
+
+[comment]: <> (The gem is available as open source under the terms of the [MIT License]&#40;https://opensource.org/licenses/MIT&#41;.)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'simple_symbolize'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_symbolize.rb

@@ -0,0 +1,37 @@
+require 'simple_symbolize/version'
+
+require_relative 'simple_symbolize/string'
+require_relative 'simple_symbolize/translations'
+
+include SimpleSymbolize
+
+module SimpleSymbolize
+  class Error < StandardError; end
+
+  # Returns the translations object, initializing it if necessary.
+  #
+  # @return [Translations] the translations object.
+  def self.translations
+    @translations ||= Translations.new
+  end
+
+  # Configures the Symbolize environment.
+  #
+  # @yieldparam [Translations] config the translations object yielded to the block.
+  def self.translate(&block)
+    yield translations
+  end
+
+  # Symbolizes a String object.
+  #
+  # @param str [String] the String object to be symbolized.
+  #
+  # @example Symbolize a string using the symbolize method
+  #   symbolize("hello world!") #=> :hello_world
+  def symbolize(str)
+    return str if str.is_a?(Symbol) || str.nil?
+
+    str.downcase.tr(SimpleSymbolize.translations.underscore.join, '_')
+      &.tr(SimpleSymbolize.translations.remove.join, '')&.to_sym
+  end
+end

data/lib/simple_symbolize/string.rb

@@ -0,0 +1,10 @@
+require 'simple_symbolize'
+
+# Extends the String class by mixing in the symbolize module.
+class String
+  # @example Symbolize a string using the String object method
+  #   "hello world!".symbolize #=> :hello_world
+  def symbolize
+    SimpleSymbolize.symbolize(self)
+  end
+end

data/lib/simple_symbolize/translations.rb

@@ -0,0 +1,68 @@
+module SimpleSymbolize
+  # The translations class holds the attributes used to transform a String object.
+  # It also provides helper methods to manipulate those attributes.
+  class Translations
+    # @return [Array] the characters to be transformed into underscores.
+    attr_accessor :underscore
+    # @return [Array] the characters to be removed from the String.
+    attr_accessor :remove
+    # @return [Array] the characters to be untouched from the String.
+    attr_accessor :omit
+
+    # Creates an instance of the Translations class.
+    #
+    # Sets the class variables to a default state.
+    def initialize
+      @underscore = [' ']
+      @remove = %w[\' ( ) , . : "]
+      @omit = []
+    end
+
+    # Merges the String passed with the @underscore Array omitting duplicates.
+    # Removes those characters from the @remove ans @omit Arrays to avoid the change being over-written.
+    #
+    # @param t [String] a String object containing characters to be underscored.
+    #
+    # @return [Array] the Array of characters to be underscored.
+    #
+    # @raise [ArgumentError] if the param does not respond to  #to_s.
+    def to_underscore(t)
+      raise ArgumentError 'needs to be a String or respond to #to_s' unless t.respond_to?(:to_s)
+
+      @remove -= t.to_s.chars
+      @omit -= t.to_s.chars
+      @underscore |= t.to_s.chars
+    end
+
+    # Merges the String passed with the @remove Array omitting duplicates.
+    # Removes those characters from the @underscore and @omit Arrays to avoid the change being over-written.
+    #
+    # @param t [String] a String object containing characters to be removed.
+    #
+    # @return [Array] the Array of characters to be removed.
+    #
+    # @raise [ArgumentError] if the param does not respond to  #to_s.
+    def to_remove(t)
+      raise ArgumentError 'needs to be a String or respond to #to_s' unless t.respond_to?(:to_s)
+
+      @underscore -= t.to_s.chars
+      @omit -= t.to_s.chars
+      @remove |= t.to_s.chars
+    end
+
+    # Removes characters within the String passed from the @remove and @underscore Arrays.
+    #
+    # @param t [String] a String object containing characters to be removed.
+    #
+    # @return [Array] the Array of characters to be omitted.
+    #
+    # @raise [ArgumentError] if the param does not respond to  #to_s.
+    def to_omit(t)
+      raise ArgumentError 'needs to be a String or respond to #to_s' unless t.respond_to?(:to_s)
+
+      @underscore -= t.to_s.chars
+      @remove -= t.to_s.chars
+      @omit += t.to_s.chars
+    end
+  end
+end

data/lib/simple_symbolize/version.rb

@@ -0,0 +1,3 @@
+module SimpleSymbolize
+  VERSION = '1.0.0'.freeze
+end

data/simple_symbolize.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/simple_symbolize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_symbolize'
+  spec.version       = SimpleSymbolize::VERSION
+  spec.authors       = ['alexo']
+  spec.email         = ['']
+
+  spec.summary       = 'Turns Strings into Symbols.'
+  spec.description   = 'simple_symbolize will remove special characters from a String, ' \
+                       'replacing whitespace with an underscore, ' \
+                       'down-casing and finally calling the #to_sym String method. ' \
+                       'Configure this gem to your hearts content!'
+  spec.homepage      = 'https://github.com/dvla/simple-symbolize'
+
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) 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']
+
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 1.18.0'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: simple_symbolize
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- alexo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+description: 'simple_symbolize will remove special characters from a String, replacing
+  whitespace with an underscore, down-casing and finally calling the #to_sym String
+  method. Configure this gem to your hearts content!'
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_symbolize.rb
+- lib/simple_symbolize/string.rb
+- lib/simple_symbolize/translations.rb
+- lib/simple_symbolize/version.rb
+- simple_symbolize.gemspec
+homepage: https://github.com/dvla/simple-symbolize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dvla/simple-symbolize
+  source_code_uri: https://github.com/dvla/simple-symbolize
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Turns Strings into Symbols.
+test_files: []