rubenum 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7cf05cb7fbb00f4b92af49a1d9f217b8214221288c895c9ab3c5f7bcc616386
+  data.tar.gz: a239697d833132e9d93830527610c3b02fe83750f00e8e7d4dd5b94e65979248
+SHA512:
+  metadata.gz: 8ea675efc270202e3a61f6cb7ee551ea2ad30c04769c150eaecbd1993657385b0624d254b9357c53623716feeb04edacd6703d5f56a12ce59c3dd7cce28794d0
+  data.tar.gz: 1c6b87567a2a1cccc0b08503663dd74223e3ce146220fa2e4973b8f88914e0d37d88a05ad2bac8746c715ce58d6dcf55a958a2b2553e08ee5eef833bd4940cf0

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019 Jérémy Blain
+
+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,17 @@
+# Rubenum
+
+Enum implementation for Ruby.
+
+Create an enum from an array of strings with `Rubenum.new`.  
+Only valid Ruby identifiers are accepted.  
+Every element will be capitalized in order to make them Ruby constants.
+
+### Arguments
+ - elements (array of string) : array containing the elements of the enum
+ - upcase (boolean optional default:false) : true to upcase elements instead of capitalize them
+ - binary_values (boolean optional default:false) : true to use binary values (1 2 4 8 16 ...) instead of incremental values (1 2 3 4 5 ...)
+
+### Example
+	e = Rubenum.new(%w[red orange green])
+	puts e::Orange   # => 2
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/lib/rubenum.rb

@@ -0,0 +1,45 @@
+# Enum implementation for Ruby.
+module Rubenum
+	# Create an enum from an array of strings.
+	# Only valid Ruby identifiers are accepted.
+	# Every element will be capitalized in order to make them Ruby constants.
+	#
+	# Arguments :
+	#  - elements (array of string) : array containing the elements of the enum
+	#  - upcase (boolean optional default:false) : true to upcase elements instead of capitalize them
+	#  - binary_values (boolean optional default:false) : true to use binary values(1 2 4 8 16 ...) instead of incremental values (1 2 3 4 5 ...)
+	#
+	# Example :
+	#     e = Rubenum.new(%w[red orange green])
+	#     puts e::Orange   # => 2
+	def self.new(elements, upcase: false, binary_values: false)
+		Module.new do |mod|
+			raise ArgumentError, "<elements> must be an array" unless elements.is_a?(Array)
+			raise ArgumentError, "<elements> can't be empty" if elements.empty?
+
+			# Format the elements and remove duplicates
+			cleaned_elements = elements.map do |e|
+				raise ArgumentError, "<elements> must only contain strings" unless e.is_a?(String)
+				upcase ? e.upcase : e.capitalize
+			end
+			cleaned_elements.uniq!
+
+			cleaned_elements.each_with_index do |e, i|
+				# Calculate the value of the element
+				value = 1
+				if binary_values
+					value <<= i
+				else
+					value += i
+				end
+
+				# Add the element to the enum
+				mod.const_set(e, value)
+			end
+
+			# Freeze the enum so it can't be modifed
+			mod.freeze
+		end
+	end
+end
+

data/rubenum.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+	s.name    = 'rubenum'
+	s.version = '1.0.0'
+	s.summary = "Enum implementation for Ruby."
+	s.author  = 'Jérémy Blain'
+	s.files   = Dir['lib/**/*'] + Dir['test/**/*']
+	s.files  += ['LICENSE', 'README.md', 'Rakefile', 'rubenum.gemspec']
+
+	s.license     = 'MIT'
+	s.homepage    = 'http://github.com/blainjeremy/rubenum'
+	s.email       = 'blain.jeremy@gmail.com'
+
+	s.date        =  '2019-05-06'
+	s.extra_rdoc_files = ['README.md', 'LICENSE']
+end
+

data/test/test_rubenum.rb

@@ -0,0 +1,90 @@
+require 'minitest/autorun'
+
+require 'rubenum'
+
+class TestRubenum < Minitest::Test
+	# Valid elements
+
+	def test_with_valid_elements
+		e = Rubenum.new(%w[First sec_ond third_ fou_rth4])
+		assert_equal e.constants.sort, [:First, :Sec_ond, :Third_, :Fou_rth4].sort
+	end
+
+	def test_when_elements_isnt_an_array
+		assert_raises ArgumentError do
+			Rubenum.new(45)
+		end
+	end
+
+	def test_with_wrong_type_of_elements
+		assert_raises ArgumentError do
+			Rubenum.new([:First, "sec_ond", ["third"], 4])
+		end
+	end
+
+	def test_with_empty_elements
+		assert_raises ArgumentError do
+			Rubenum.new([])
+		end
+	end
+
+	def test_duplicate_elements_are_made_unique
+		e = Rubenum.new(%w[First first sec_ond third_ fou_rth4])
+		assert_equal e.constants.sort, [:First, :Sec_ond, :Third_, :Fou_rth4].sort
+	end
+
+	def test_with_a_single_char
+		e = Rubenum.new(%w[First x sec_ond third_ fou_rth4])
+		assert_equal e.constants.sort, [:First, :X, :Sec_ond, :Third_, :Fou_rth4].sort
+	end
+
+	def test_not_working_with_a_space_char
+		assert_raises NameError do
+			Rubenum.new(["First", "sec ond", "third_", "fou_rth4"])
+		end
+	end
+
+	def test_not_working_with_a_leading_underscore
+		assert_raises NameError do
+			Rubenum.new(%w[First _sec_ond third_ fou_rth4])
+		end
+	end
+
+	def test_not_working_with_a_special_char
+		assert_raises NameError do
+			Rubenum.new(%w[First sec!ond third_ fou_rth4])
+		end
+	end
+
+	def test_not_working_with_a_leading_digit
+		assert_raises NameError do
+			Rubenum.new(%w[First 2sec_ond third_ fou_rth4])
+		end
+	end
+
+	# Upcase option
+
+	def test_upcase
+		e = Rubenum.new(%w[First sec_ond third_ fou_rth4], upcase: true)
+		assert_equal e.constants.sort, [:FIRST, :SEC_OND, :THIRD_, :FOU_RTH4].sort
+	end
+
+	# Binary values option
+
+	def test_with_decimal
+		e = Rubenum.new(%w[First sec_ond third_ fou_rth4])
+		assert_equal 1, e::First
+		assert_equal 2, e::Sec_ond
+		assert_equal 3, e::Third_
+		assert_equal 4, e::Fou_rth4
+	end
+
+	def test_with_binary
+		e = Rubenum.new(%w[First sec_ond third_ fou_rth4], binary_values: true)
+		assert_equal 1, e::First
+		assert_equal 2, e::Sec_ond
+		assert_equal 4, e::Third_
+		assert_equal 8, e::Fou_rth4
+	end
+end
+

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: rubenum
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jérémy Blain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: blain.jeremy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubenum.rb
+- rubenum.gemspec
+- test/test_rubenum.rb
+homepage: http://github.com/blainjeremy/rubenum
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Enum implementation for Ruby.
+test_files: []