class-enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e435a5446138814a1233b79b3ab4274983358e5e
+  data.tar.gz: e06a6fa83ce1c54f5f8cd42ae0ad9f8e679fc3b5
+SHA512:
+  metadata.gz: 07890f28d6bcc883775e66d801ca54f8ceb7a5526e79fabee7a6a58f3405487e9b35def7f5e1a3422ddef8401d69b7b312e9b6f30dda0bc0c9ba05d2596a4365
+  data.tar.gz: d432e0f6924edf5dc9c6aec1fd209b59d9cf98dcf41236d07e83020fe91d0223ab2f63710ac03a2ead33da221ab84921d00c2210e2c34934042266d8dad55109

data/README.md

@@ -0,0 +1,88 @@
+# Class::Enum
+
+java-like class enum for Ruby
+
+```ruby
+class Animal
+	include Class::Enum
+	
+	attr_reader :sound
+	
+	def initialize(sound)
+		@sound = sound
+	end
+	
+	field :CAT, "meow"
+	field :DOG, "bark"
+	field :BIRD, "tweet"
+end
+
+puts Animal::CAT.sound # meow
+
+case Animal::CAT
+when Animal
+	puts "An animal"
+else
+	puts "X"
+end
+# An animal
+
+Animal::CAT.instance_of?(Animal) # => true
+Animal::CAT.class # => Animal
+```
+
+## Requirements
+- No (Ruby 1.9+?)
+
+## Usage
+See [documentation](http://www.rubydoc.info/gems/class-enum)
+
+## Examples
+
+### Using block
+```ruby
+class Animal
+	include Class::Enum
+	
+	attr_reader :block
+	
+	def initialize(&block)
+		@block = block
+	end
+	
+	field :CAT do
+		puts "meow"
+	end
+end
+
+Animal::CAT.block.call # meow
+```
+
+### Using keyword arguments
+You can keyword arguments only if ruby 2.0+.
+If not ruby 2.0+, this gem doesn't use keyword arguments
+
+```ruby
+class Animal
+	include Class::Enum
+	
+	attr_reader :sound
+	
+	def initialize(sound:)
+		@sound = sound
+	end
+	
+	field :CAT, sound: "meow"
+end
+
+puts Animal::CAT.sound # meow
+```
+
+## Author
+Sputnik Gugja (sputnikgugja@gmail.com)
+
+## License
+This is free software released into the public domain (CC0 license).
+
+See `LICENSE` file.
+

data/lib/class/enum.rb

@@ -0,0 +1,103 @@
+class Class
+	# Utility for defining java-like enum type
+	module Enum
+		VERSION = '0.0.1'.freeze
+		
+		def self.included(base)
+			base.send :extend, ClassMethods
+			base.private_class_method :new
+		end
+		
+		module ClassMethods
+			# @!method field(name, *args, **kwargs, &block)
+			#   @param [#to_sym] name
+			#   @param args Arguments for constructor
+			#   @param kwargs Keyword arguments for constructor
+			#     **This argument exists only if ruby 2.0+**
+			#   @param block A block for constructor
+			#   @return A created object
+			if RUBY_VERSION >= '2.0'
+				eval <<-RUBY
+					# @param [#to_sym] name
+					# @param args Arguments for constructor
+					# @param kwargs Keyword arguments for constructor
+					# @param block A block for constructor
+					# @return A created object
+					def field(name, *args, **kwargs, &block)
+						if kwargs.empty?
+							obj = self.send(:new, *args, &block)
+						else
+							obj = self.send(:new, *args, **kwargs, &block)
+						end
+						name = name.to_sym
+						const_set(name, obj)
+						@enum_fields ||= {}
+						@enum_fields[name] = obj
+						obj
+					end
+				RUBY
+			else
+				eval <<-RUBY
+					# @param [#to_sym] name
+					# @param args Arguments for constructor
+					# @param block A block for constructor
+					# @return A created object
+					def field(name, *args, &block)
+						obj = self.send(:new, *args, &block)
+						name = name.to_sym
+						const_set(name, obj)
+						@enum_fields ||= {}
+						@enum_fields[name] = obj
+						obj
+					end
+				RUBY
+			end
+			
+			# Checks a field of given name exists
+			# You can also do like `Animal::DOG.instance_of?(Animal)`
+			# 
+			# @param [#to_sym] name
+			# @return [Boolean]
+			def key?(name)
+				name = name.to_sym
+				@enum_fields.key?(name)
+			end
+			
+			# Checks given value is a field of this enum
+			# 
+			# @param obj
+			# @return [Boolean]
+			def value?(obj)
+				@enum_fields.value?(obj)
+			end
+			
+			# Gets a field by given name
+			# You can also do like `Animal::DOG`
+			# 
+			# @param [#to_sym] name
+			# @return A enum field with given name. If not exists, nil
+			def value(name)
+				@enum_fields[name.to_sym]
+			end
+			
+			# Gets an array of enum fields
+			# @return [Array] (copied) An array of enum fields
+			def values
+				@enum_fields.values
+			end
+			alias_method :to_a, :values
+			
+			# Gets an array of enum field names
+			# @return [Array<Symbol>] (copied) An array of enum field names
+			def keys
+				@enum_fields.keys
+			end
+			
+			# Gets an hash of enum fields
+			# @return [Hash{Symbol, Object}] (copied) An hash of enum fields
+			def to_h
+				@enum_fields.dup
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: class-enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sputnik Gugja
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-10 00:00:00.000000000 Z
+dependencies: []
+description: java-like class enum for Ruby
+email:
+- sputnikgugja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/class/enum.rb
+homepage: https://github.com/sputnikgugja/rb_event
+licenses:
+- CC0-1.0
+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.6.3
+signing_key: 
+specification_version: 4
+summary: java-like class enum for Ruby
+test_files: []
+has_rdoc: