slug_converter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52009d2f55bbbe0aedf2df3da9e692b6211196cf
+  data.tar.gz: 8b10108a86b73fb589b54671f736d78f8424e614
+SHA512:
+  metadata.gz: 7d5d3b955dc172c91f2e325fd1ddee33d26839422e60b4c670fd41c616e351118ea9bbca21645cdc8d9700c9cdf6065b2185474403dc3079f20d1768d041e9d1
+  data.tar.gz: 04e867b4a05e60d59c883ea1020dee7b96eedb11999411df208da24215b86904aa2b207282c76b4cf2f0f0e186363d27df225d884604632cf6e25ce8c8aa508b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## V0.0.1
+
+* inital release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slug_converter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jovana Dacic
+
+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,44 @@
+# SlugConverter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slug_converter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slug_converter
+
+## Usage
+To define your own alphabet for slug, create an initializer config/initializers/slug_converter.rb and add configuration
+
+  SlugConverter.configuration.alphabet = "your characters go here"
+
+In order to get a encoded slug based on the provided integer value initialize SlugConverter like this
+
+  slug = SlugConverter.new(number).slug
+
+the same way you can get the decoded integer value based on the given slug like this
+
+number = SlugConverter.new(slug).number
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/slug_converter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slug_converter"
+
+# 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

data/bin/setup

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

data/lib/slug_converter.rb

@@ -0,0 +1,81 @@
+require "slug_converter/version"
+require 'set'
+require 'gem_config'
+
+class SlugConverter
+
+  include GemConfig::Base
+
+  with_configuration do
+    has :alphabet, default: "qjeghxtrpnfmdzwvsybkuoca"
+  end
+
+  def initialize(number_or_slug)
+     @alphabet = SlugConverter.configuration.alphabet.split(//)
+    if number_or_slug.to_i != 0
+      @number = number_or_slug.to_i
+    elsif validate_string(number_or_slug)
+      @slug = number_or_slug.downcase
+    else
+      raise ArgumentError, 'Argument must be integer value or non-empty string consisting of predefined letters'
+    end
+  end
+
+  def number
+    if @number.nil?
+      @number = bijective_decode
+    else
+      @number
+    end
+  end
+
+  def number=(new_number)
+    @number = new_number
+    @slug = bijective_encode
+    @number
+  end
+
+  def slug
+    if @slug.nil?
+      @slug = bijective_encode
+    else
+      @slug
+    end
+  end
+
+  def slug=(new_slug)
+    @slug = new_slug
+    @number = bijective_decode
+    @slug
+  end
+
+  private
+
+    def bijective_encode
+      id = @number
+      return @alphabet[0] if id == 0
+      s = ''
+      base = @alphabet.length
+      while id > 0
+        s << @alphabet[id.modulo(base)]
+        id /= base
+      end
+      s.reverse
+    end
+
+    def bijective_decode
+      i = 0
+      base = @alphabet.length
+      @slug.each_char { |c| i = i * base + @alphabet.index(c) }
+      i
+    end
+
+    def validate_string(slug)
+      unless slug.nil?
+        alphabet = Set.new @alphabet
+        slug_letters = Set.new slug.downcase().split(//)
+        slug != "" && (slug_letters.subset? alphabet)
+      end
+    end
+
+end

data/lib/slug_converter/version.rb

@@ -0,0 +1,3 @@
+class SlugConverter
+  VERSION = "0.0.1"
+end

data/slug_converter.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slug_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slug_converter"
+  spec.version       = SlugConverter::VERSION
+  spec.authors       = ["Jovana Dacic"]
+  spec.email         = ["jovanadacic@gmail.com"]
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  # end
+
+  spec.summary       = %q{Number <-> Slug converter}
+  spec.description   = %q{Generates a slug based on the given number and the other way around}
+  spec.homepage      = "https://github.com/orangeiceberg/slug_converter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'gem_config'
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: slug_converter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jovana Dacic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates a slug based on the given number and the other way around
+email:
+- jovanadacic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slug_converter.rb
+- lib/slug_converter/version.rb
+- slug_converter.gemspec
+- tasks/rspec.rake
+homepage: https://github.com/orangeiceberg/slug_converter
+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.5
+signing_key: 
+specification_version: 4
+summary: Number <-> Slug converter
+test_files: []