bijective 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e54e88636e6e344cb2c2562a744f0fc5b8206d0
-  data.tar.gz: 0e9ce56aeb1c7bde458a5dc9e372fceed0435d2e
+  metadata.gz: ac434b4d245a7f10b36c4ed8e44363dcd09abcd2
+  data.tar.gz: 5e9d82d69e59620ed490dbf624f715f121ab3af8
 SHA512:
-  metadata.gz: 2bbed7df489380bc49533cd3fa0edbb9928de0f4d04600137d85e53ca81320dca0380fa745241cbd7568ad302d94a423096ca36dbf9bb5d9a8d358b394ee89ec
-  data.tar.gz: 731c2e262747af55a7f3ee199a067c1c8a2f759941e823f6f24e07db9a02cbb5cf7d6d06ceec5158f08569d305d5859524757cf2c4ecf6ddcc8840905deecb4d
+  metadata.gz: 21f96aab0bf5ec0cbffeb426e38deb33e7035ce525d1913ed4f42cf6887a23c64f54b13aa69bbec4b27b9e8d76504efd56d478d1e678737d0976a13dc550390b
+  data.tar.gz: 2ee3a69d68aaa927987d6964110bfcde1a8439d37f3d2e8781098ab1094692472e72d29dcaebb2fe93891fb45e7bc77c39c4af0fea10cd14c0fa4d154ff8085f

data/.gitignore

@@ -1 +1,2 @@
 README.html
+/*.gem

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - ruby-head
+  - jruby-head
+  - 1.9.3
+  - 1.8.7
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+
+branches:
+  only:
+    - development

data/README.md

@@ -1,4 +1,4 @@
-# bijective
+# bijective [![Build Status](https://travis-ci.org/dnshl/bijective.png)](https://travis-ci.org/dnshl/bijective)
 
 ## Install
 	gem install bijective
@@ -9,5 +9,22 @@
 - Create a new instance with generated sequence
 - Encode or decode
 
+```
+irb(main):001:0> require 'bijective'
+=> true
+
+irb(main):002:0> sequence = Bijective::Generator.generate_sequence
+=> "10mQU8Hc64YhgbItfkKvX37NzlZrVweRx5OJBPqni2dLuDEpsFoMjyATS9aGWC"
+
+irb(main):003:0> bijective = Bijective::Instance.new(sequence)
+=> #<Bijective::Instance:0x007fe931a80800 @sequence="10mQU8Hc64YhgbItfkKvX37NzlZrVweRx5OJBPqni2dLuDEpsFoMjyATS9aGWC", @base=62>
+
+irb(main):004:0> bijective.encode(91939)
+=> "NST"
+
+irb(main):005:0> bijective.decode('NST')
+=> 91939
+```
+
 ## License
 See License file.

data/bijective.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = "bijective can be used to decode strings and encode numbers"
   s.authors     = ["Dennis Hall"]
   s.email       = 'dennis@dennishall.de'
-  s.homepage    = 'http://rubygems.org/gems/bijective'
+  s.homepage    = 'https://github.com/dnshl/bijective'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/bijective.rb

@@ -3,6 +3,12 @@ require 'bijective/initialization_error'
 
 module Bijective
   class Instance
+    # Constructor initialises instance variables @sequence and @base.
+    #
+    # @param sequence [String] set instance object variable @sequence
+    # @raise [InitializationError] if sequence parameter has duplicate
+    #   characters
+    # @return [Instance] new object instance
     def initialize sequence
       dublicate = sequence.split(//).uniq.join
 
@@ -14,9 +20,12 @@ module Bijective
       @base = @sequence.length
     end
 
-    # returns string
+    # Encodes the given integer
+    #
+    # @param i [Integer] the integer to encode
+    # @return [String] the encoded string
     def encode i
-      return @sequence[0] if i == 0
+      return @sequence[0,1] if i == 0
       s = ''
       while i > 0
         s << @sequence[i.modulo(@base)]
@@ -25,7 +34,10 @@ module Bijective
       s.reverse
     end
 
-    # returns integer
+    # Decodes the given string
+    #
+    # @param s [String] the string to decode
+    # @return [Integer] the decoded integer
     def decode s
       i = 0
       s.each_char { |c| i = i * @base + @sequence.index(c) }

data/lib/bijective/generator.rb

@@ -1,5 +1,9 @@
 module Bijective
   class Generator
+    # Class method to generate a random string containing uppercase / lowercase
+    # letters and numbers from 0 to 9
+    #
+    # @return [String] random string; with length 62
     def self.generate_sequence
       upcase_letters   = ('A'..'Z').to_a
       downcase_letters = ('a'..'z').to_a

data/lib/bijective/version.rb

@@ -1,3 +1,3 @@
 module Bijective
-  VERSION = '0.0.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bijective
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dennis Hall
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - License
 - README.md
 - Rakefile
@@ -29,7 +30,7 @@ files:
 - test/test_bijective.rb
 - test/test_generator.rb
 - test/test_initialization_error.rb
-homepage: http://rubygems.org/gems/bijective
+homepage: https://github.com/dnshl/bijective
 licenses: []
 metadata: {}
 post_install_message: