acronyms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2434f3f8985c7065e9bc5987535e448bb91f38ab
+  data.tar.gz: b7e052fc020ccaebc9f6e08bdecc624c8f16a587
+SHA512:
+  metadata.gz: 2941eb3cc0957df8cbe51b9198ce9109548f6f756e70fec08320d2e2914a44b84fe3b24fb9b0fe5e1cf07343d3076eb7300e9c5500199994a53ad6155befc562
+  data.tar.gz: 1dc0d0f48e23f9487eaedd304a1db9932864588c77cb36c034f76c380fe2594667f5300a6ec1db94a3099e2df58b424d7682cff20ea07f09e12a7b4aa6288a6a

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'coveralls', '~> 0.8'
+  gem 'flay', '~> 2.6'
+  gem 'flog', '~> 4.3'
+  gem 'guard-rspec', '~> 4.6'
+  gem 'jeweler', '~> 2.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 0.31'
+  gem 'simplecov', '~> 0.10'
+end

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: 'bundle exec rspec --color --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+notification :off

data/README.md

@@ -0,0 +1,15 @@
+# acronyms
+
+Ruby gem for generating acronyms from string.
+
+```
+'Grand Theft Auto'.acronyms
+=> ['GTA']
+'Counter-Strike'.acronyms
+=> ['CS']
+'Left 4 Dead'.acronyms
+=> ['L4D']
+'Grand Theft Auto IV'.acronyms
+['GTAIV', 'GTA4']
+```
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require_relative 'lib/version'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see
+  # http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'acronyms'
+  gem.version = AcronymsVersion.to_s
+  gem.homepage = 'https://github.com/pixelastic/acronyms'
+  gem.license = 'MIT'
+  gem.summary = 'Generate acronyms from strings'
+  gem.description = 'Generate acronyms from strings'
+  gem.email = 'tim@pixelastic.com'
+  gem.authors = ['Tim Carry']
+
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '--color --format documentation'
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task test: :spec
+
+desc 'Code coverage detail'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task default: :test

data/lib/acronyms.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+
+# Extending base String class with `.acronyms`
+class String
+  def acronyms
+    return [] if empty?
+    split = self.split(/[\s\-]/)
+
+    romans = %w(I II III IV V VI VII VIII IX)
+
+    # If a word is a roman numeral, we keep it, othewise we take the first
+    # letter
+    acronym = split.map do |word|
+      romans.index(word).nil? ? word[0] : word
+    end
+    acronym = acronym.join('')
+
+    # If a word is a roman numeral, we convert it, otherwise we take the first
+    # letter
+    acronym_roman = split.map do |word|
+      roman_index = romans.index(word)
+      !roman_index.nil? ? roman_index + 1 : word.upcase[0]
+    end
+    acronym_roman = acronym_roman.join('')
+
+    [acronym, acronym_roman].uniq
+  end
+end

data/lib/version.rb

@@ -0,0 +1,6 @@
+# Expose gem version
+class AcronymsVersion
+  def self.to_s
+    '0.1.0'
+  end
+end

data/scripts/bump_version

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require_relative '../lib/version.rb'
+
+class BumpVersion
+  def initialize(*args)
+    @type = args[0]
+    if !valid_type?(@type)
+      puts "Invalid bump type: #{@type}"
+      exit 1
+    end
+  end
+
+  def valid_type?(type)
+    %w(major minor patch).include?(type)
+  end
+
+  def bump(current_version, type)
+    major, minor, patch = current_version.split('.').map(&:to_i)
+    if type == 'major'
+      major += 1
+      minor = 0
+      patch = 0
+    end
+    if type == 'minor'
+      minor += 1
+      patch = 0
+    end
+    patch += 1 if type == 'patch'
+    "#{major}.#{minor}.#{patch}"
+  end
+
+  def run
+    old_version = AcronymsVersion.to_s
+    new_version = bump(old_version, @type)
+
+    script_dir = File.expand_path(File.dirname(__FILE__))
+    file = File.join(script_dir, '../lib/version.rb')
+    old_content = File.read(file)
+    new_content = old_content.gsub(old_version, new_version)
+    File.write(file, new_content)
+
+    `git add #{file}`
+    `git commit -m "chore(bump): Version bump to #{new_version}"`
+  end
+
+end
+BumpVersion.new(*ARGV).run

data/scripts/check_flay

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+MAX_SCORE = 45
+
+flay_lines = `flay -s ./lib/`.split("\n")
+
+errors = []
+flay_lines.each_with_index do |line, index|
+  # Skip header
+  next if index < 2
+
+  pattern = /^ *(.*): (.*)/
+  matches = line.match(pattern)
+  next if matches.nil?
+  score = matches[1].to_f
+
+  next if score < MAX_SCORE
+  errors << {
+    score: score,
+    file: matches[2]
+  }
+end
+
+exit 0 if errors.size == 0
+
+puts 'Flay test failed:'
+errors.sort_by { |a| a[:score] }.each do |error|
+  puts "#{error[:score]} / #{MAX_SCORE} in #{error[:file]}"
+end
+exit 1

data/scripts/check_flog

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+MAX_SCORE = 45
+
+flog_lines = `flog ./lib/`.split("\n")
+
+errors = []
+flog_lines.each_with_index do |line, index|
+  # Skip header
+  next if index < 3
+
+  pattern = /^ *(.*): (.*) (.*):[0-9]*/
+  matches = line.match(pattern)
+  next if matches.nil?
+  score = matches[1].to_f
+
+  next if score < MAX_SCORE
+  errors << {
+    score: score,
+    method: matches[2],
+    file: matches[3]
+  }
+end
+
+exit 0 if errors.size == 0
+
+puts 'Flog test failed:'
+errors.sort_by { |a| a[:score] }.each do |error|
+  puts "#{error[:score]} / #{MAX_SCORE}: #{error[:method]} in #{error[:file]}"
+end
+exit 1

data/scripts/git_hooks/pre-commit

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Succeed fast if we did not change any ruby file
+if ! git status --short | grep -q '\.rb$'; then
+  exit 0
+fi
+
+# Do not commit any focused or excluded tests
+if grep --color -r 'spec' -E -e '^( |\t)*(fit|fdescribe|xit|xdescribe)'; then
+  echo '✘ You have focused and/or skipped tests'
+  exit 1
+fi
+
+# Match style guide
+./scripts/lint || exit 1
+

data/scripts/git_hooks/pre-push

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+./scripts/test || exit 1
+
+# No over-complex methods
+./scripts/check_flog || exit 1
+
+# No duplication
+./scripts/check_flay

data/scripts/lint

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+rubocop -F './lib/' './spec'

data/scripts/release

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+set -ev
+
+git checkout master
+git pull
+bundle install
+
+git rebase develop
+bundle install
+rake release
+
+git checkout develop
+git rebase master 
+bundle install

data/scripts/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+cd "$(dirname "$BASH_SOURCE")"/..
+
+bundle exec rspec

data/scripts/watch

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+cd "$(dirname "$BASH_SOURCE")"/..
+
+guard

data/spec/acronyms_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe(String) do
+  describe 'acronyms' do
+    it 'should return an array' do
+      # Given
+      input = 'Grand Theft Auto'
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to be_instance_of(Array)
+    end
+
+    it 'should contain first letter of each word' do
+      # Given
+      input = 'Grand Theft Auto'
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to include('GTA')
+    end
+
+    it 'should return an empty array on empty string' do
+      # Given
+      input = ''
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to eql([])
+    end
+
+    it 'should split on dashes' do
+      # Given
+      input = 'Counter-Strike'
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to include('CS')
+    end
+
+    it 'should handle numerals' do
+      # Given
+      input = 'Left 4 Dead'
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to include('L4D')
+    end
+
+    it 'should keep roman numerals' do
+      # Given
+      input = 'Grand Theft Auto IV'
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to include('GTAIV')
+    end
+
+    it 'should convert roman numerals' do
+      # Given
+      input = 'Grand Theft Auto IV'
+
+      # When
+      actual = input.acronyms
+
+      # Then
+      expect(actual).to include('GTA4')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require_relative './spec_helper_simplecov.rb'
+require './lib/acronyms.rb'
+
+RSpec.configure do |config|
+  config.filter_run(focus: true)
+  config.fail_fast = true
+  config.run_all_when_everything_filtered = true
+end

data/spec/spec_helper_simplecov.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+
+SimpleCov.configure do
+  load_profile 'test_frameworks'
+end
+
+ENV['COVERAGE'] && SimpleCov.start do
+  add_filter '/.rvm/'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: acronyms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Carry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Generate acronyms from strings
+email: tim@pixelastic.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".rspec"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/acronyms.rb
+- lib/version.rb
+- scripts/bump_version
+- scripts/check_flay
+- scripts/check_flog
+- scripts/git_hooks/pre-commit
+- scripts/git_hooks/pre-push
+- scripts/lint
+- scripts/release
+- scripts/test
+- scripts/watch
+- spec/acronyms_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_simplecov.rb
+homepage: https://github.com/pixelastic/acronyms
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generate acronyms from strings
+test_files: []