ruby_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c6a72a675c8fb1c4a85809100aec69936f5a817
+  data.tar.gz: 860b5ca16bada4964b91e6d254cec40e517c69cb
+SHA512:
+  metadata.gz: 5134691adf41fa028d5276548228ee7df8de5788052cffc1748730c39f55954ae5c85f0d04a31c458e96fa8af368e735d342771e868bf2a69d3afc8050b8e58f
+  data.tar.gz: 70e290e118a5700ba880daed557ed9a6678eecdcf55b4fec46b60e5c8ecc00b72e1652e08d8e264c3807fdfcbfb9e2f5a21042b8a8e54de177c2502744898f54

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    ruby_enum (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.8)
+  rake (~> 10.0)
+  rspec (~> 3.3.0)
+  ruby_enum!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lefteris Laskaridis
+
+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,48 @@
+# RubyEnum
+
+A simple enumeration type for ruby classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_enum
+
+## Usage
+
+To create an enumeration type simply include the `RubyEnum` module and define the enumeration values as follows:
+```ruby
+class Coordinates
+  include RubyEnum
+  
+  enum :north
+  enum :south
+  enum :west
+  enum :east
+```
+
+Including `RubyEnum` in any class will make it a singleton. This means that you can't use `new`, `allocate`, `clone` or `dup` on that class. You can access enumeration values however as follows:
+
+## 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]/ruby_enum/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"
+

data/bin/console

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

@@ -0,0 +1,3 @@
+module RubyEnum
+  VERSION = "0.1.0"
+end

data/lib/ruby_enum.rb

@@ -0,0 +1,76 @@
+require "ruby_enum/version"
+
+module RubyEnum
+
+  def self.included(base)
+    # enmeration instances are singleton values
+    base.private_class_method(:new, :allocate)
+    base.extend(ClassMethods)
+    base.include(InstanceMethods)
+  end
+
+  module InstanceMethods
+
+    # the value associated with the enumeration instance
+    def raw_value
+      @_value
+    end
+
+    def clone
+      raise TypeError, "can't clone instance of enum #{self.class}"
+    end
+
+    def dup
+      raise TypeError, "can't dupe instance of enum #{self.class}"
+    end
+
+    private
+
+    def initialize(value)
+      @_value = value
+    end
+  end
+
+  module ClassMethods
+
+    # enable retrieving enumeration values as constants
+    def const_missing(name)
+      self[name] || super
+    end
+
+    # defines enumeration values
+    def enum(name, value = nil)
+      @_instances ||= {}
+
+      normalized_name = normalize name
+      if self[normalized_name]
+        raise ArgumentError, "An enumeration value for #{normalized_name} has " \
+          "already been defined in #{self.name}."
+      else
+        value = normalized_name.to_s unless value
+        define_instance_accessor_for normalized_name
+        @_instances[normalized_name] = new value
+      end
+    end
+
+    def [](name)
+      @_instances[normalize(name)]
+    end
+
+    def all
+      @_instances.map { |_, instance| instance }
+    end
+
+    private
+
+    def define_instance_accessor_for(name)
+      self.class.instance_eval do
+        define_method(name) { return self[name] }
+      end
+    end
+
+    def normalize(name)
+      name.to_s.downcase.to_sym
+    end
+  end
+end

data/ruby_enum.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_enum"
+  spec.version       = RubyEnum::VERSION
+  spec.authors       = ["Lefteris Laskaridis"]
+  spec.email         = ["l.laskaridis@pamediakopes.gr"]
+
+  spec.summary       = %q{Simple enumeration type for ruby}
+  spec.description   = %q{Implementation of a simple enumeration type for ruby}
+  spec.homepage      = "http://www.laskaridis.cm"
+  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", "~> 3.3.0"
+end

data/tags

@@ -0,0 +1,20 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.9~svn20110310	//
+ClassMethods	lib/ruby_enum.rb	/^  module ClassMethods$/;"	m	class:RubyEnum
+Coordinates	spec/ruby_enum_spec.rb	/^      class Coordinates$/;"	c
+Member	lib/ruby_enum/member.rb	/^  class Member$/;"	c	class:RubyEnum
+RubyEnum	lib/ruby_enum.rb	/^module RubyEnum$/;"	m
+RubyEnum	lib/ruby_enum/member.rb	/^module RubyEnum$/;"	m
+RubyEnum	lib/ruby_enum/version.rb	/^module RubyEnum$/;"	m
+[]	lib/ruby_enum.rb	/^    def [](member_name)$/;"	f	class:RubyEnum.ClassMethods
+enum	lib/ruby_enum.rb	/^    def enum(name, value = nil)$/;"	f	class:RubyEnum.ClassMethods
+enumeration_members	lib/ruby_enum.rb	/^    def enumeration_members$/;"	f	class:RubyEnum.ClassMethods
+enumeration_value_for	lib/ruby_enum.rb	/^    def enumeration_value_for(member_name)$/;"	f	class:RubyEnum.ClassMethods
+find_enumeration_member_by	lib/ruby_enum.rb	/^    def find_enumeration_member_by(name)$/;"	f	class:RubyEnum.ClassMethods
+included	lib/ruby_enum.rb	/^  def self.included(base)$/;"	F	class:RubyEnum
+initialize	lib/ruby_enum/member.rb	/^    def initialize(name, value = nil)$/;"	f	class:RubyEnum.Member
+method_missing	lib/ruby_enum.rb	/^  def method_missing(name, *args, &blk)$/;"	f	class:RubyEnum

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ruby_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lefteris Laskaridis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-15 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: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: Implementation of a simple enumeration type for ruby
+email:
+- l.laskaridis@pamediakopes.gr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_enum.rb
+- lib/ruby_enum/version.rb
+- ruby_enum.gemspec
+- tags
+homepage: http://www.laskaridis.cm
+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.6
+signing_key: 
+specification_version: 4
+summary: Simple enumeration type for ruby
+test_files: []